annotate qiime_gneiss_balance-taxonomy.xml @ 0:09b7bcb72fa7 draft

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