annotate qiime2/qiime_gneiss_balance-taxonomy.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_gneiss_balance-taxonomy" name="qiime gneiss balance-taxonomy" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Balance Summary</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 gneiss balance-taxonomy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
6
florianbegusch
parents: 0
diff changeset
10
florianbegusch
parents: 0
diff changeset
11 #if str( $id_to_taxonomy_fp.selector ) == 'history'
florianbegusch
parents: 0
diff changeset
12 #set $tax = $id_to_taxonomy_fp.taxonomy_fp
florianbegusch
parents: 0
diff changeset
13 --i-taxonomy '$tax'
florianbegusch
parents: 0
diff changeset
14 #else:
florianbegusch
parents: 0
diff changeset
15 #set $tax = $id_to_taxonomy_fp.taxonomy_fp.fields.path
florianbegusch
parents: 0
diff changeset
16 --i-taxonomy '$tax'
florianbegusch
parents: 0
diff changeset
17 #end if
florianbegusch
parents: 0
diff changeset
18
florianbegusch
parents: 0
diff changeset
19
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --i-tree=$itree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-balance-name="$pbalancename"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
6
florianbegusch
parents: 0
diff changeset
25
florianbegusch
parents: 0
diff changeset
26 #if $metadatafile:
florianbegusch
parents: 0
diff changeset
27 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
6
florianbegusch
parents: 0
diff changeset
31
florianbegusch
parents: 0
diff changeset
32 #if str($ppseudocount):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --p-pseudocount=$ppseudocount
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
6
florianbegusch
parents: 0
diff changeset
36 #if str($ptaxalevel):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --p-taxa-level=$ptaxalevel
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39
6
florianbegusch
parents: 0
diff changeset
40 #if str($pnfeatures):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --p-n-features=$pnfeatures
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #if str($pthreshold):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --p-threshold="$pthreshold"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($mmetadatacolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <inputs>
6
florianbegusch
parents: 0
diff changeset
58
florianbegusch
parents: 0
diff changeset
59 <conditional name="id_to_taxonomy_fp" optional="True">
florianbegusch
parents: 0
diff changeset
60 <param name="selector" type="select" label="Reference taxonomy to query">
florianbegusch
parents: 0
diff changeset
61 <option value="cached">Public databases</option>
florianbegusch
parents: 0
diff changeset
62 <option value="history">Databases from your history</option>
florianbegusch
parents: 0
diff changeset
63 </param>
florianbegusch
parents: 0
diff changeset
64 <when value="cached">
florianbegusch
parents: 0
diff changeset
65 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
florianbegusch
parents: 0
diff changeset
66 <options from_data_table="qiime_taxonomy" />
florianbegusch
parents: 0
diff changeset
67 </param>
florianbegusch
parents: 0
diff changeset
68 </when>
florianbegusch
parents: 0
diff changeset
69 <when value="history">
florianbegusch
parents: 0
diff changeset
70 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
florianbegusch
parents: 0
diff changeset
71 </when>
florianbegusch
parents: 0
diff changeset
72 </conditional>
florianbegusch
parents: 0
diff changeset
73
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] A table of abundances. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT The tree used to calculate the balances. Hierarchy [required]" name="itree" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <param format="qza,no_unzip.zip" label="--i-taxonomy: ARTIFACT FeatureData[Taxonomy] Taxonomy information for the OTUs. [required]" name="itaxonomy" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <param label="--p-balance-name: TEXT Name of the balance to summarize. [required]" name="pbalancename" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <param label="--p-pseudocount: NUMBER The pseudocount to add to avoid division by zero. [default: 0.5]" name="ppseudocount" optional="True" type="float" value="0.5"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <param label="--p-taxa-level: INTEGER Level of taxonomy to summarize. [default: 0]" name="ptaxalevel" optional="True" type="integer" value="0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <param label="--p-n-features: INTEGER The number of features to plot in the proportion plot. [default: 10]" name="pnfeatures" optional="True" type="integer" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <param label="--p-threshold: NUMBER A threshold to designate discrete categories for a numerical metadata column. This will split the numerical column values into two categories, values below the threshold, and values above the threshold. If not specified, this threshold will default to the mean. [optional]" name="pthreshold" optional="True" type="float"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical | Numeric] Metadata column for plotting the balance (optional). [optional]" name="mmetadatacolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83
6
florianbegusch
parents: 0
diff changeset
84 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" optional="True" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 Balance Summary
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 ###############
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 Visualize the distribution of a single balance and summarize its numerator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 and denominator components.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 A table of abundances.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 tree : Hierarchy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 The tree used to calculate the balances.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 taxonomy : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Taxonomy information for the OTUs.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 balance_name : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 Name of the balance to summarize.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 pseudocount : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 The pseudocount to add to avoid division by zero.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 taxa_level : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 Level of taxonomy to summarize.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 n_features : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 The number of features to plot in the proportion plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 threshold : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 A threshold to designate discrete categories for a numerical metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 column. This will split the numerical column values into two
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 categories, values below the threshold, and values above the threshold.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 If not specified, this threshold will default to the mean.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 metadata : MetadataColumn[Categorical | Numeric], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 Metadata column for plotting the balance (optional).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 </tool>