annotate qiime2/qiime_diversity_core-metrics.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" name="qiime diversity core-metrics" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Core diversity metrics (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
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
6
florianbegusch
parents: 4
diff changeset
11
florianbegusch
parents: 4
diff changeset
12 #if str($psamplingdepth):
florianbegusch
parents: 4
diff changeset
13 --p-sampling-depth="$psamplingdepth"
florianbegusch
parents: 4
diff changeset
14 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
21 #if $input_files_mmetadatafile:
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #for d in list_dict[1:]:
4
florianbegusch
parents: 2
diff changeset
25 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
30 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --o-rarefied-table=orarefiedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --o-observed-otus-vector=oobservedotusvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 --o-shannon-vector=oshannonvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --o-evenness-vector=oevennessvector
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --o-jaccard-distance-matrix=ojaccarddistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --o-bray-curtis-distance-matrix=obraycurtisdistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --o-jaccard-pcoa-results=ojaccardpcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-bray-curtis-pcoa-results=obraycurtispcoaresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --o-jaccard-emperor=ojaccardemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --o-bray-curtis-emperor=obraycurtisemperor
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 cp orarefiedtable.qza $orarefiedtable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 cp oobservedotusvector.qza $oobservedotusvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 cp oshannonvector.qza $oshannonvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 cp oevennessvector.qza $oevennessvector;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 cp ojaccarddistancematrix.qza $ojaccarddistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 cp obraycurtisdistancematrix.qza $obraycurtisdistancematrix;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 cp ojaccardpcoaresults.qza $ojaccardpcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 cp obraycurtispcoaresults.qza $obraycurtispcoaresults;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 qiime tools export --input-path ojaccardemperor.qzv --output-path out && mkdir -p '$ojaccardemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 && cp -r out/* '$ojaccardemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 && mv '$ojaccardemperor.files_path/index.html' '$ojaccardemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 qiime tools export --input-path obraycurtisemperor.qzv --output-path out && mkdir -p '$obraycurtisemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 && cp -r out/* '$obraycurtisemperor.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 && mv '$obraycurtisemperor.files_path/index.html' '$obraycurtisemperor';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <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
60 <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
61
4
florianbegusch
parents: 2
diff changeset
62 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--m-metadata-file: METADATA... (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
64 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <data format="qza" label="${tool.name} on ${on_string}: rarefiedtable.qza" name="orarefiedtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <data format="qza" label="${tool.name} on ${on_string}: observedotusvector.qza" name="oobservedotusvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <data format="qza" label="${tool.name} on ${on_string}: shannonvector.qza" name="oshannonvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <data format="qza" label="${tool.name} on ${on_string}: evennessvector.qza" name="oevennessvector"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <data format="qza" label="${tool.name} on ${on_string}: jaccarddistancematrix.qza" name="ojaccarddistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <data format="qza" label="${tool.name} on ${on_string}: braycurtisdistancematrix.qza" name="obraycurtisdistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <data format="qza" label="${tool.name} on ${on_string}: jaccardpcoaresults.qza" name="ojaccardpcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <data format="qza" label="${tool.name} on ${on_string}: braycurtispcoaresults.qza" name="obraycurtispcoaresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <data format="html" label="${tool.name} on ${on_string}: jaccardemperor.qzv" name="ojaccardemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <data format="html" label="${tool.name} on ${on_string}: braycurtisemperor.qzv" name="obraycurtisemperor"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 Core diversity metrics (non-phylogenetic)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 #########################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Applies a collection of diversity metrics (non-phylogenetic) to a feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 The feature table containing the samples over which diversity metrics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 sampling_depth : Int % Range(1, None)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 The total frequency that each sample should be rarefied to prior to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 computing diversity metrics.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 The sample metadata to use in the emperor plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 rarefied_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 The resulting rarefied feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 observed_otus_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 Vector of Observed OTUs values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 shannon_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Vector of Shannon diversity values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 evenness_vector : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 Vector of Pielou's evenness values by sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 jaccard_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 Matrix of Jaccard distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 bray_curtis_distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 Matrix of Bray-Curtis distances between pairs of samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 jaccard_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 PCoA matrix computed from Jaccard distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 bray_curtis_pcoa_results : PCoAResults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 PCoA matrix computed from Bray-Curtis distances between samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 jaccard_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Emperor plot of the PCoA matrix computed from Jaccard.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 bray_curtis_emperor : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 Emperor plot of the PCoA matrix computed from Bray-Curtis.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 </tool>