annotate qiime2/qiime_diversity_alpha-rarefaction.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents de4c22a52df4
children f190567fe3f6
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_alpha-rarefaction" name="qiime diversity alpha-rarefaction" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Alpha rarefaction curves</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 alpha-rarefaction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
6
florianbegusch
parents: 0
diff changeset
11
florianbegusch
parents: 0
diff changeset
12
florianbegusch
parents: 0
diff changeset
13 #if str($pmaxdepth):
florianbegusch
parents: 0
diff changeset
14 --p-max-depth="$pmaxdepth"
florianbegusch
parents: 0
diff changeset
15 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($iphylogeny) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --i-phylogeny=$iphylogeny
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($pmetrics) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-metrics=$pmetrics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
6
florianbegusch
parents: 0
diff changeset
26 #if str($pmindepth):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-min-depth=$pmindepth
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
6
florianbegusch
parents: 0
diff changeset
30 #if str($psteps):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-steps=$psteps
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
6
florianbegusch
parents: 0
diff changeset
34 #if str($piterations):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-iterations=$piterations
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #for d in list_dict[1:]:
6
florianbegusch
parents: 0
diff changeset
42 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table to compute rarefaction curves from. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-max-depth: INTEGER The maximum rarefaction depth. Must be greater than Range(1, None) min-depth. [required]" name="pmaxdepth" optional="False" min="1" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <param format="qza,no_unzip.zip" label="--i-phylogeny: ARTIFACT Optional phylogeny for phylogenetic metrics. Phylogeny[Rooted] [optional]" name="iphylogeny" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-metrics: " name="pmetrics" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="dominance">dominance</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="ace">ace</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="brillouin_d">brillouin_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="margalef">margalef</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="menhinick">menhinick</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="mcintosh_d">mcintosh_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="berger_parker_d">berger_parker_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="enspie">enspie</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <option value="doubles">doubles</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <option value="lladser_pe">lladser_pe</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="observed_otus">observed_otus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="faith_pd">faith_pd</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="simpson_e">simpson_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="robbins">robbins</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="shannon">shannon</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="pielou_e">pielou_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="singles">singles</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="michaelis_menten_fit">michaelis_menten_fit</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="heip_e">heip_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="mcintosh_e">mcintosh_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="fisher_alpha">fisher_alpha</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="goods_coverage">goods_coverage</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="chao1">chao1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <option value="gini_index">gini_index</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="simpson">simpson</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <param label="--p-min-depth: INTEGER The minimum rarefaction depth. Range(1, None) [default: 1]" name="pmindepth" optional="True" type="integer" min="1" value="1"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <param label="--p-steps: INTEGER The number of rarefaction depths to include between Range(2, None) min-depth and max-depth. [default: 10]" name="psteps" optional="True" type="integer" min="2" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <param label="--p-iterations: INTEGER The number of rarefied feature tables to compute at Range(1, None) each step. [default: 10]" name="piterations" optional="True" type="integer" min="1" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <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. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 Alpha rarefaction curves
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 ########################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Generate interactive alpha rarefaction curves by computing rarefactions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 between `min_depth` and `max_depth`. The number of intermediate depths to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 compute is controlled by the `steps` parameter, with n `iterations` being
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 computed at each rarefaction depth. If sample metadata is provided, samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 may be grouped based on distinct values within a metadata column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 Feature table to compute rarefaction curves from.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 max_depth : Int % Range(1, None)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 The maximum rarefaction depth. Must be greater than min_depth.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 phylogeny : Phylogeny[Rooted], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Optional phylogeny for phylogenetic metrics.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 metrics : Set[Str % Choices('pielou_e', 'simpson_e', 'shannon', 'margalef', 'menhinick', 'brillouin_d', 'mcintosh_e', 'doubles', 'robbins', 'simpson', 'enspie', 'fisher_alpha', 'heip_e', 'singles', 'michaelis_menten_fit', 'observed_otus', 'gini_index', 'dominance', 'goods_coverage', 'mcintosh_d', 'faith_pd', 'ace', 'chao1', 'lladser_pe', 'berger_parker_d')], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 The metrics to be measured. By default computes observed_otus, shannon,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 and if phylogeny is provided, faith_pd.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 metadata : Metadata, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 The sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 min_depth : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 The minimum rarefaction depth.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 steps : Int % Range(2, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 The number of rarefaction depths to include between min_depth and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 max_depth.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 iterations : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 The number of rarefied feature tables to compute at each step.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 </tool>