annotate qiime2/qiime_diversity_core-metrics-phylogenetic.xml @ 0:51b9b6b57732 draft

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