annotate qiime2/qiime_diversity_beta-rarefaction.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents de4c22a52df4
children f190567fe3f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_beta-rarefaction" name="qiime diversity beta-rarefaction" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Beta diversity rarefaction</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime diversity beta-rarefaction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
6
florianbegusch
parents: 4
diff changeset
11
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-metric=$pmetric
6
florianbegusch
parents: 4
diff changeset
13
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-clustering-method=$pclusteringmethod
6
florianbegusch
parents: 4
diff changeset
15
florianbegusch
parents: 4
diff changeset
16 #if str($psamplingdepth):
florianbegusch
parents: 4
diff changeset
17 --p-sampling-depth="$psamplingdepth"
florianbegusch
parents: 4
diff changeset
18 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($iphylogeny) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --i-phylogeny=$iphylogeny
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
6
florianbegusch
parents: 4
diff changeset
24 #if str($piterations):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-iterations=$piterations
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($pcorrelationmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-correlation-method=$pcorrelationmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #if str($pcolorscheme) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --p-color-scheme=$pcolorscheme
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
36 #if $input_files_mmetadatafile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #for d in list_dict[1:]:
4
florianbegusch
parents: 2
diff changeset
40 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
45 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table upon which to perform beta diversity rarefaction analyses. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--p-metric: " name="pmetric" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="kulsinski">kulsinski</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <option value="euclidean">euclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option value="wminkowski">wminkowski</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="dice">dice</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="correlation">correlation</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="hamming">hamming</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="canberra">canberra</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="canberra_adkins">canberra_adkins</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="rogerstanimoto">rogerstanimoto</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="sqeuclidean">sqeuclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="cosine">cosine</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="seuclidean">seuclidean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="weighted_normalized_unifrac">weighted_normalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <option value="sokalmichener">sokalmichener</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <option value="unweighted_unifrac">unweighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="cityblock">cityblock</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="generalized_unifrac">generalized_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="weighted_unifrac">weighted_unifrac</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="braycurtis">braycurtis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="jaccard">jaccard</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="sokalsneath">sokalsneath</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="aitchison">aitchison</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="matching">matching</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="chebyshev">chebyshev</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="russellrao">russellrao</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="yule">yule</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="mahalanobis">mahalanobis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <param label="--p-clustering-method: " name="pclusteringmethod" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="upgma">upgma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="nj">nj</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <param label="--p-sampling-depth: INTEGER Range(1, None) The total frequency that each sample should be rarefied to prior to computing the diversity metric. [required]" name="psamplingdepth" optional="False" min="1" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <param format="qza,no_unzip.zip" label="--i-phylogeny: ARTIFACT Phylogenetic tree containing tip identifiers that Phylogeny[Rooted] correspond to the feature identifiers in the table. This tree can contain tip ids that are not present in the table, but all feature ids in the table must be present in this tree. [required for phylogenetic metrics] [optional]" name="iphylogeny" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <param label="--p-iterations: INTEGER Number of times to rarefy the feature table at a Range(2, None) given sampling depth. [default: 10]" name="piterations" optional="True" type="integer" min="2" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <param label="--p-correlation-method: " name="pcorrelationmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <option value="spearman">spearman</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <option value="pearson">pearson</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <param label="--p-color-scheme: " name="pcolorscheme" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <option value="BrBG">BrBG</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <option value="BrBG_r">BrBG_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <option value="PRGn">PRGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <option value="PRGn_r">PRGn_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <option value="PiYG">PiYG</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <option value="PiYG_r">PiYG_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <option value="PuOr">PuOr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <option value="PuOr_r">PuOr_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <option value="RdBu">RdBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <option value="RdBu_r">RdBu_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <option value="RdGy">RdGy</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <option value="RdGy_r">RdGy_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 <option value="RdYlBu">RdYlBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <option value="RdYlBu_r">RdYlBu_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <option value="RdYlGn">RdYlGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <option value="RdYlGn_r">RdYlGn_r</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115
4
florianbegusch
parents: 2
diff changeset
116 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 <param label="--m-metadata-file: METADATA... (multiple arguments will be merged) The sample metadata used for the Emperor jackknifed PCoA plot. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 Beta diversity rarefaction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 ##########################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 Repeatedly rarefy a feature table to compare beta diversity results within
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 a given rarefaction depth. For a given beta diversity metric, this
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 visualizer will provide: an Emperor jackknifed PCoA plot, samples clustered
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 by UPGMA or neighbor joining with support calculation, and a heatmap
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 showing the correlation between rarefaction trials of that beta diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 metric.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 Feature table upon which to perform beta diversity rarefaction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 analyses.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 metric : Str % Choices('generalized_unifrac', 'sokalmichener', 'matching', 'yule', 'weighted_normalized_unifrac', 'dice', 'russellrao', 'rogerstanimoto', 'mahalanobis', 'wminkowski', 'kulsinski', 'aitchison', 'seuclidean', 'correlation', 'sokalsneath', 'hamming', 'jaccard', 'unweighted_unifrac', 'weighted_unifrac', 'cosine', 'canberra', 'euclidean', 'sqeuclidean', 'chebyshev', 'cityblock', 'canberra_adkins', 'braycurtis')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 The beta diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 clustering_method : Str % Choices('upgma', 'nj')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 Samples can be clustered with neighbor joining or UPGMA. An arbitrary
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 rarefaction trial will be used for the tree, and the remaining trials
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 are used to calculate the support of the internal nodes of that tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 The sample metadata used for the Emperor jackknifed PCoA plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 sampling_depth : Int % Range(1, None)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 The total frequency that each sample should be rarefied to prior to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 computing the diversity metric.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 iterations : Int % Range(2, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 Number of times to rarefy the feature table at a given sampling depth.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 phylogeny : Phylogeny[Rooted], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 Phylogenetic tree containing tip identifiers that correspond to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 present in this tree. [required for phylogenetic metrics]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 correlation_method : Str % Choices('pearson', 'spearman'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 The Mantel correlation test to be applied when computing correlation
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 between beta diversity distance matrices.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 color_scheme : Str % Choices('BrBG', 'BrBG_r', 'PRGn', 'PRGn_r', 'PiYG', 'PiYG_r', 'PuOr', 'PuOr_r', 'RdBu', 'RdBu_r', 'RdGy', 'RdGy_r', 'RdYlBu', 'RdYlBu_r', 'RdYlGn', 'RdYlGn_r'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 The matplotlib color scheme to generate the heatmap with.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172 </tool>