annotate qiime_diversity_core-metrics.xml @ 1:f2028d8efed6 draft default tip

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