annotate qiime2/qiime_taxa_collapse.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_taxa_collapse" name="qiime taxa collapse" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description>- Collapse features by their taxonomy at the specified level</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 taxa collapse --p-level="$plevel"
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 --o-collapsed-table=ocollapsedtable
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 cp ocollapsedtable.qza $ocollapsedtable;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 </command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] Feature table to be collapsed. [required]" name="itable" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 <conditional name="id_to_taxonomy_fp" optional="True">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 <param name="selector" type="select" label="Reference taxonomy to query">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 <option value="cached">Public databases</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 <option value="history">Databases from your history</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 <when value="cached">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 <options from_data_table="qiime_taxonomy" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 </when>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 <when value="history">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 </when>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43 </conditional>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 <param label="--p-level: The taxonomic level at which the features should be collapsed. All ouput features will have exactly this many levels of taxonomic annotation. [required]" name="plevel" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 <data format="qza" label="${tool.name} on ${on_string}: collapsed-table.qza" name="ocollapsedtable"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 Collapse features by their taxonomy at the specified level
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 -----------------------------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 Collapse groups of features that have the same taxonomic assignment through
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58 the specified level. The frequencies of all features will be summed when
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 they are collapsed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 Feature table to be collapsed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 taxonomy : FeatureData[Taxonomy]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66 Taxonomic annotations for features in the provided feature table. All
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 features in the feature table must have a corresponding taxonomic
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 annotation. Taxonomic annotations that are not present in the feature
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69 table will be ignored.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 level : Int
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 The taxonomic level at which the features should be collapsed. All
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 ouput features will have exactly this many levels of taxonomic
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 annotation.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 collapsed_table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 The resulting feature table, where all features are now taxonomic
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 annotations with the user-specified number of levels.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 </tool>