annotate qiime2/qiime_gneiss_balance-taxonomy.xml @ 2:149432539226 draft

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 01:49:31 -0400
parents
children 71f124e02000
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
149432539226 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_gneiss_balance-taxonomy" name="qiime gneiss balance-taxonomy" version="2019.4">
149432539226 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Balance Summary</description>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
8 qiime gneiss balance-taxonomy
149432539226 Uploaded
florianbegusch
parents:
diff changeset
9
149432539226 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
149432539226 Uploaded
florianbegusch
parents:
diff changeset
11 --i-tree=$itree
149432539226 Uploaded
florianbegusch
parents:
diff changeset
12 --i-taxonomy=$itaxonomy
149432539226 Uploaded
florianbegusch
parents:
diff changeset
13 --p-balance-name="$pbalancename"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
14
149432539226 Uploaded
florianbegusch
parents:
diff changeset
15
149432539226 Uploaded
florianbegusch
parents:
diff changeset
16 #if $input_files_mmetadatafile:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
17 #def list_dict_to_string(list_dict):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
18 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
19 #for d in list_dict[1:]:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
20 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
149432539226 Uploaded
florianbegusch
parents:
diff changeset
21 #end for
149432539226 Uploaded
florianbegusch
parents:
diff changeset
22 #return $file_list
149432539226 Uploaded
florianbegusch
parents:
diff changeset
23 #end def
149432539226 Uploaded
florianbegusch
parents:
diff changeset
24 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
149432539226 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
26
149432539226 Uploaded
florianbegusch
parents:
diff changeset
27
149432539226 Uploaded
florianbegusch
parents:
diff changeset
28 #if $ppseudocount:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
29 --p-pseudocount=$ppseudocount
149432539226 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
31
149432539226 Uploaded
florianbegusch
parents:
diff changeset
32 #if $ptaxalevel:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
33 --p-taxa-level=$ptaxalevel
149432539226 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
35
149432539226 Uploaded
florianbegusch
parents:
diff changeset
36 #if $pnfeatures:
149432539226 Uploaded
florianbegusch
parents:
diff changeset
37 --p-n-features=$pnfeatures
149432539226 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
39
149432539226 Uploaded
florianbegusch
parents:
diff changeset
40 #if str($pthreshold):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
41 --p-threshold="$pthreshold"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
43 #if str($mmetadatacolumn):
149432539226 Uploaded
florianbegusch
parents:
diff changeset
44 --m-metadata-column="$mmetadatacolumn"
149432539226 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
149432539226 Uploaded
florianbegusch
parents:
diff changeset
46
149432539226 Uploaded
florianbegusch
parents:
diff changeset
47 --o-visualization=ovisualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
48 ;
149432539226 Uploaded
florianbegusch
parents:
diff changeset
49 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
50 && cp -r out/* '$ovisualization.files_path'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
51 && mv '$ovisualization.files_path/index.html' '$ovisualization'
149432539226 Uploaded
florianbegusch
parents:
diff changeset
52 ]]></command>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
53 <inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
54 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] A table of abundances. [required]" name="itable" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
55 <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"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
56 <param format="qza,no_unzip.zip" label="--i-taxonomy: ARTIFACT FeatureData[Taxonomy] Taxonomy information for the OTUs. [required]" name="itaxonomy" optional="False" type="data"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-balance-name: TEXT Name of the balance to summarize. [required]" name="pbalancename" optional="False" type="text"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
58 <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"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-taxa-level: INTEGER Level of taxonomy to summarize. [default: 0]" name="ptaxalevel" optional="True" type="integer" value="0"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
60 <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"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
61 <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"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
62 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical | Numeric] Metadata column for plotting the balance (optional). [optional]" name="mmetadatacolumn" optional="True" type="text"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
63
149432539226 Uploaded
florianbegusch
parents:
diff changeset
64 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
149432539226 Uploaded
florianbegusch
parents:
diff changeset
65 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
149432539226 Uploaded
florianbegusch
parents:
diff changeset
66 </repeat>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
67
149432539226 Uploaded
florianbegusch
parents:
diff changeset
68 </inputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
69 <outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
70 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
71 </outputs>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
72 <help><![CDATA[
149432539226 Uploaded
florianbegusch
parents:
diff changeset
73 Balance Summary
149432539226 Uploaded
florianbegusch
parents:
diff changeset
74 ###############
149432539226 Uploaded
florianbegusch
parents:
diff changeset
75
149432539226 Uploaded
florianbegusch
parents:
diff changeset
76 Visualize the distribution of a single balance and summarize its numerator
149432539226 Uploaded
florianbegusch
parents:
diff changeset
77 and denominator components.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
78
149432539226 Uploaded
florianbegusch
parents:
diff changeset
79 Parameters
149432539226 Uploaded
florianbegusch
parents:
diff changeset
80 ----------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
81 table : FeatureTable[Frequency]
149432539226 Uploaded
florianbegusch
parents:
diff changeset
82 A table of abundances.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
83 tree : Hierarchy
149432539226 Uploaded
florianbegusch
parents:
diff changeset
84 The tree used to calculate the balances.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
85 taxonomy : FeatureData[Taxonomy]
149432539226 Uploaded
florianbegusch
parents:
diff changeset
86 Taxonomy information for the OTUs.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
87 balance_name : Str
149432539226 Uploaded
florianbegusch
parents:
diff changeset
88 Name of the balance to summarize.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
89 pseudocount : Float, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
90 The pseudocount to add to avoid division by zero.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
91 taxa_level : Int, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
92 Level of taxonomy to summarize.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
93 n_features : Int, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
94 The number of features to plot in the proportion plot.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
95 threshold : Float, optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
96 A threshold to designate discrete categories for a numerical metadata
149432539226 Uploaded
florianbegusch
parents:
diff changeset
97 column. This will split the numerical column values into two
149432539226 Uploaded
florianbegusch
parents:
diff changeset
98 categories, values below the threshold, and values above the threshold.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
99 If not specified, this threshold will default to the mean.
149432539226 Uploaded
florianbegusch
parents:
diff changeset
100 metadata : MetadataColumn[Categorical | Numeric], optional
149432539226 Uploaded
florianbegusch
parents:
diff changeset
101 Metadata column for plotting the balance (optional).
149432539226 Uploaded
florianbegusch
parents:
diff changeset
102
149432539226 Uploaded
florianbegusch
parents:
diff changeset
103 Returns
149432539226 Uploaded
florianbegusch
parents:
diff changeset
104 -------
149432539226 Uploaded
florianbegusch
parents:
diff changeset
105 visualization : Visualization
149432539226 Uploaded
florianbegusch
parents:
diff changeset
106 ]]></help>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
107 <macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
108 <import>qiime_citation.xml</import>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
109 </macros>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
110 <expand macro="qiime_citation"/>
149432539226 Uploaded
florianbegusch
parents:
diff changeset
111 </tool>