annotate qiime2/qiime_gneiss_balance-taxonomy.xml @ 0:51b9b6b57732 draft

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