annotate qiime2/qiime_diversity_core-metrics.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_core-metrics" name="qiime diversity core-metrics"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Core diversity metrics (non-phylogenetic)</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity core-metrics
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-sampling-depth=$psamplingdepth
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14 # if $input_files_mmetadatafile:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 # def list_dict_to_string(list_dict):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 # for d in list_dict[1:]:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 # end for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 # return $file_list
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 # end def
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 # end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #if $pwithreplacement:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 --p-with-replacement
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #if str($pnjobs) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 --p-n-jobs=$pnjobs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 --o-rarefied-table=orarefiedtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 --o-observed-features-vector=oobservedfeaturesvector
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 --o-shannon-vector=oshannonvector
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 --o-evenness-vector=oevennessvector
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 --o-jaccard-distance-matrix=ojaccarddistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 --o-bray-curtis-distance-matrix=obraycurtisdistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 --o-jaccard-pcoa-results=ojaccardpcoaresults
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 --o-bray-curtis-pcoa-results=obraycurtispcoaresults
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 --o-jaccard-emperor=ojaccardemperor
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 --o-bray-curtis-emperor=obraycurtisemperor
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 cp obraycurtispcoaresults.qza $obraycurtispcoaresults
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 qiime tools export ojaccardemperor.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 && mkdir -p '$ojaccardemperor.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 && cp -r out/* '$ojaccardemperor.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 && mv '$ojaccardemperor.files_path/index.html' '$ojaccardemperor'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 qiime tools export obraycurtisemperor.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 && mkdir -p '$obraycurtisemperor.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 && cp -r out/* '$obraycurtisemperor.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 && mv '$obraycurtisemperor.files_path/index.html' '$obraycurtisemperor'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table containing the samples over which diversity metrics should be computed. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 <param label="--p-sampling-depth: INTEGER Range(1, None) The total frequency that each sample should be rarefied to prior to computing diversity metrics. [required]" name="psamplingdepth" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple The sample metadata to use in the emperor plots. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 <param label="--p-with-replacement: --p-with-replacement: / --p-no-with-replacement Rarefy with replacement by sampling from the multinomial distribution instead of rarefying without replacement. [default: False]" name="pwithreplacement" selected="False" type="boolean" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="Int % Range(1">Int % Range(1</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="None">None</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 <data format="qza" label="${tool.name} on ${on_string}: rarefiedtable.qza" name="orarefiedtable" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 <data format="qza" label="${tool.name} on ${on_string}: observedfeaturesvector.qza" name="oobservedfeaturesvector" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 <data format="qza" label="${tool.name} on ${on_string}: shannonvector.qza" name="oshannonvector" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 <data format="qza" label="${tool.name} on ${on_string}: evennessvector.qza" name="oevennessvector" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 <data format="qza" label="${tool.name} on ${on_string}: jaccarddistancematrix.qza" name="ojaccarddistancematrix" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 <data format="qza" label="${tool.name} on ${on_string}: braycurtisdistancematrix.qza" name="obraycurtisdistancematrix" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96 <data format="qza" label="${tool.name} on ${on_string}: jaccardpcoaresults.qza" name="ojaccardpcoaresults" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 <data format="qza" label="${tool.name} on ${on_string}: braycurtispcoaresults.qza" name="obraycurtispcoaresults" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 <data format="html" label="${tool.name} on ${on_string}: jaccardemperor.html" name="ojaccardemperor" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99 <data format="html" label="${tool.name} on ${on_string}: braycurtisemperor.html" name="obraycurtisemperor" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 Core diversity metrics (non-phylogenetic)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 Applies a collection of diversity metrics (non-phylogenetic) to a feature
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108 table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
109
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
110 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
111 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
112 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
113 The feature table containing the samples over which diversity metrics
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
114 should be computed.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
115 sampling_depth : Int % Range(1, None)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
116 The total frequency that each sample should be rarefied to prior to
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
117 computing diversity metrics.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
118 metadata : Metadata
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
119 The sample metadata to use in the emperor plots.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
120 with_replacement : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
121 Rarefy with replacement by sampling from the multinomial distribution
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
122 instead of rarefying without replacement.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
123 n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
124 [beta methods only] - The number of concurrent jobs to use in
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
125 performing this calculation. May not exceed the number of available
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
126 physical cores. If n_jobs = 'auto', one job will be launched for each
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
127 identified CPU core on the host.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
128
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
129 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
130 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
131 rarefied_table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
132 The resulting rarefied feature table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
133 observed_features_vector : SampleData[AlphaDiversity]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
134 Vector of Observed Features values by sample.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
135 shannon_vector : SampleData[AlphaDiversity]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
136 Vector of Shannon diversity values by sample.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
137 evenness_vector : SampleData[AlphaDiversity]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
138 Vector of Pielou's evenness values by sample.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
139 jaccard_distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
140 Matrix of Jaccard distances between pairs of samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
141 bray_curtis_distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
142 Matrix of Bray-Curtis distances between pairs of samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
143 jaccard_pcoa_results : PCoAResults
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
144 PCoA matrix computed from Jaccard distances between samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
145 bray_curtis_pcoa_results : PCoAResults
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
146 PCoA matrix computed from Bray-Curtis distances between samples.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
147 jaccard_emperor : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
148 Emperor plot of the PCoA matrix computed from Jaccard.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
149 bray_curtis_emperor : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
150 Emperor plot of the PCoA matrix computed from Bray-Curtis.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
151 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
152 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
153 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
154 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
155 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
156 </tool>