annotate qiime2/qiime_taxa_collapse.xml @ 10:21c7954105a9 draft

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