annotate qiime2/qiime_diversity_core-metrics-phylogenetic.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents de4c22a52df4
children a0a8d77a991c
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" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
2 <tool id="qiime_diversity_core-metrics-phylogenetic" name="qiime diversity core-metrics-phylogenetic" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Core diversity metrics (phylogenetic and non- phylogenetic)</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
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 core-metrics-phylogenetic
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-phylogeny=$iphylogeny
6
florianbegusch
parents: 4
diff changeset
12
florianbegusch
parents: 4
diff changeset
13 #if str($psamplingdepth):
florianbegusch
parents: 4
diff changeset
14 --p-sampling-depth="$psamplingdepth"
florianbegusch
parents: 4
diff changeset
15 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
22
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
23 #if $input_files_mmetadatafile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #for d in list_dict[1:]:
6
florianbegusch
parents: 4
diff changeset
27 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end def
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
31 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
32 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --o-rarefied-table=orarefiedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --o-faith-pd-vector=ofaithpdvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --o-observed-otus-vector=oobservedotusvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-shannon-vector=oshannonvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --o-evenness-vector=oevennessvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --o-unweighted-unifrac-distance-matrix=ounweightedunifracdistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 --o-weighted-unifrac-distance-matrix=oweightedunifracdistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --o-jaccard-distance-matrix=ojaccarddistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --o-bray-curtis-distance-matrix=obraycurtisdistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --o-unweighted-unifrac-pcoa-results=ounweightedunifracpcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 --o-weighted-unifrac-pcoa-results=oweightedunifracpcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 --o-jaccard-pcoa-results=ojaccardpcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --o-bray-curtis-pcoa-results=obraycurtispcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 --o-unweighted-unifrac-emperor=ounweightedunifracemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 --o-weighted-unifrac-emperor=oweightedunifracemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 --o-jaccard-emperor=ojaccardemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 --o-bray-curtis-emperor=obraycurtisemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 cp orarefiedtable.qza $orarefiedtable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 cp ofaithpdvector.qza $ofaithpdvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 cp oobservedotusvector.qza $oobservedotusvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 cp oshannonvector.qza $oshannonvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 cp oevennessvector.qza $oevennessvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 cp ounweightedunifracdistancematrix.qza $ounweightedunifracdistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 cp oweightedunifracdistancematrix.qza $oweightedunifracdistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 cp ojaccarddistancematrix.qza $ojaccarddistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 cp obraycurtisdistancematrix.qza $obraycurtisdistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 cp ounweightedunifracpcoaresults.qza $ounweightedunifracpcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 cp oweightedunifracpcoaresults.qza $oweightedunifracpcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 cp ojaccardpcoaresults.qza $ojaccardpcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 cp obraycurtispcoaresults.qza $obraycurtispcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 qiime tools export --input-path ounweightedunifracemperor.qzv --output-path out && mkdir -p '$ounweightedunifracemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 && cp -r out/* '$ounweightedunifracemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 && mv '$ounweightedunifracemperor.files_path/index.html' '$ounweightedunifracemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 qiime tools export --input-path oweightedunifracemperor.qzv --output-path out && mkdir -p '$oweightedunifracemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 && cp -r out/* '$oweightedunifracemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 && mv '$oweightedunifracemperor.files_path/index.html' '$oweightedunifracemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 qiime tools export --input-path ojaccardemperor.qzv --output-path out && mkdir -p '$ojaccardemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 && cp -r out/* '$ojaccardemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 && mv '$ojaccardemperor.files_path/index.html' '$ojaccardemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 qiime tools export --input-path obraycurtisemperor.qzv --output-path out && mkdir -p '$obraycurtisemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 && cp -r out/* '$obraycurtisemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 && mv '$obraycurtisemperor.files_path/index.html' '$obraycurtisemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <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]" name="iphylogeny" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <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" min="1" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84
4
florianbegusch
parents: 2
diff changeset
85 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file [required]">
florianbegusch
parents: 2
diff changeset
86 <param label="--m-metadata-file: (multiple arguments will be merged) The sample metadata to use in the emperor plots. [required]" name="additional_input" optional="False" type="data" format="tabular,qza,no_unzip.zip" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <data format="qza" label="${tool.name} on ${on_string}: rarefiedtable.qza" name="orarefiedtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <data format="qza" label="${tool.name} on ${on_string}: faithpdvector.qza" name="ofaithpdvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <data format="qza" label="${tool.name} on ${on_string}: observedotusvector.qza" name="oobservedotusvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <data format="qza" label="${tool.name} on ${on_string}: shannonvector.qza" name="oshannonvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <data format="qza" label="${tool.name} on ${on_string}: evennessvector.qza" name="oevennessvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <data format="qza" label="${tool.name} on ${on_string}: unweightedunifracdistancematrix.qza" name="ounweightedunifracdistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <data format="qza" label="${tool.name} on ${on_string}: weightedunifracdistancematrix.qza" name="oweightedunifracdistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <data format="qza" label="${tool.name} on ${on_string}: jaccarddistancematrix.qza" name="ojaccarddistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <data format="qza" label="${tool.name} on ${on_string}: braycurtisdistancematrix.qza" name="obraycurtisdistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <data format="qza" label="${tool.name} on ${on_string}: unweightedunifracpcoaresults.qza" name="ounweightedunifracpcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <data format="qza" label="${tool.name} on ${on_string}: weightedunifracpcoaresults.qza" name="oweightedunifracpcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <data format="qza" label="${tool.name} on ${on_string}: jaccardpcoaresults.qza" name="ojaccardpcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <data format="qza" label="${tool.name} on ${on_string}: braycurtispcoaresults.qza" name="obraycurtispcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <data format="html" label="${tool.name} on ${on_string}: unweightedunifracemperor.qzv" name="ounweightedunifracemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <data format="html" label="${tool.name} on ${on_string}: weightedunifracemperor.qzv" name="oweightedunifracemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <data format="html" label="${tool.name} on ${on_string}: jaccardemperor.qzv" name="ojaccardemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <data format="html" label="${tool.name} on ${on_string}: braycurtisemperor.qzv" name="obraycurtisemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 Core diversity metrics (phylogenetic and non-phylogenetic)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 ##########################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 Applies a collection of diversity metrics (both phylogenetic and non-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 phylogenetic) to a feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 The feature table containing the samples over which diversity metrics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 phylogeny : Phylogeny[Rooted]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 Phylogenetic tree containing tip identifiers that correspond to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 sampling_depth : Int % Range(1, None)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 The total frequency that each sample should be rarefied to prior to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 computing diversity metrics.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 The sample metadata to use in the emperor plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 rarefied_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 The resulting rarefied feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 faith_pd_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 Vector of Faith PD values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 observed_otus_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 Vector of Observed OTUs values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 shannon_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 Vector of Shannon diversity values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 evenness_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 Vector of Pielou's evenness values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 unweighted_unifrac_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 Matrix of unweighted UniFrac distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 weighted_unifrac_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 Matrix of weighted UniFrac distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 jaccard_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 Matrix of Jaccard distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 bray_curtis_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 Matrix of Bray-Curtis distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 unweighted_unifrac_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 PCoA matrix computed from unweighted UniFrac distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 weighted_unifrac_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 PCoA matrix computed from weighted UniFrac distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 jaccard_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 PCoA matrix computed from Jaccard distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 bray_curtis_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 PCoA matrix computed from Bray-Curtis distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 unweighted_unifrac_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 Emperor plot of the PCoA matrix computed from unweighted UniFrac.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 weighted_unifrac_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163 Emperor plot of the PCoA matrix computed from weighted UniFrac.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 jaccard_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 Emperor plot of the PCoA matrix computed from Jaccard.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 bray_curtis_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 Emperor plot of the PCoA matrix computed from Bray-Curtis.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
173 </tool>