annotate qiime2/qiime_diversity_core-metrics-phylogenetic.xml @ 0:370e0b6e9826 draft

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