annotate qiime2/qiime_feature-classifier_classify-consensus-vsearch.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_feature-classifier_classify-consensus-vsearch" name="qiime feature-classifier classify-consensus-vsearch" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - VSEARCH consensus taxonomy classifier</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><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
8 qiime feature-classifier classify-consensus-vsearch --i-query=$iquery
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
10 #if str( $id_to_taxonomy_fp.selector ) == 'history'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
11 #set $tax = $id_to_taxonomy_fp.taxonomy_fp
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
12 --i-reference-taxonomy '$tax'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
13 #else:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
14 #set $tax = $id_to_taxonomy_fp.taxonomy_fp.fields.path
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15 --i-reference-taxonomy '$tax'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
17
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
18 --i-reference-reads=$ireferencereads
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
19 #if $ppercidentity:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20 --p-perc-identity=$ppercidentity
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pminconsensus:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 --p-min-consensus=$pminconsensus
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($pstrand) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 --p-strand=$pstrand
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 --o-classification=oclassification
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 #if str($punassignablelabel):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 --p-unassignable-label="$punassignablelabel"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 #set $pthreads = '${GALAXY_SLOTS:-4}'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 --p-threads="$pthreads"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 #if $pmaxaccepts:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 --p-maxaccepts=$pmaxaccepts
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 cp oclassification.qza $oclassification;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 ]]></command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 <param format="qza,no_unzip.zip" label="--i-query: FeatureData[Sequence] Sequences to classify taxonomically. [required]" name="iquery" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 <param format="qza,no_unzip.zip" label="--i-reference-reads: FeatureData[Sequence] reference sequences. [required]" name="ireferencereads" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 <conditional name="id_to_taxonomy_fp" optional="True">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 <param name="selector" type="select" label="Reference taxonomy to query">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="cached">Public databases</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 <option value="history">Databases from your history</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 <when value="cached">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 <options from_data_table="qiime_taxonomy" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 </when>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 <when value="history">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66 </when>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 </conditional>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-maxaccepts: Maximum number of hits to keep for each query. Must be in range [0, infinity]. [default: 10]" name="pmaxaccepts" optional="True" type="integer" value="10"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-perc-identity: Reject match if percent identity to query is lower. Must be in range [0.0, 1.0]. [default: 0.8]" name="ppercidentity" optional="True" type="float" value="0.8"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-strand: [both|plus] Align against reference sequences in forward ('plus') or both directions ('both'). [default: both]" name="pstrand" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 <option selected="True" value="both">both</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="plus">plus</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 <param label="--p-min-consensus: Minimum fraction of assignments must match top hit to be accepted as consensus assignment. Must be in range (0.5, 1.0]. [default: 0.51]" name="pminconsensus" optional="True" type="float" value="0.51"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 <param label="--p-unassignable-label: [default: Unassigned]" name="punassignablelabel" optional="True" type="text" value="Unassigned"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <help><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 VSEARCH consensus taxonomy classifier
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 -------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 Assign taxonomy to query sequences using VSEARCH. Performs VSEARCH global
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87 alignment between query and reference_reads, then assigns consensus
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88 taxonomy to each query sequence from among maxaccepts top hits,
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 min_consensus of which share that taxonomic assignment.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 query : FeatureData[Sequence]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94 Sequences to classify taxonomically.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
95 reference_reads : FeatureData[Sequence]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96 reference sequences.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97 reference_taxonomy : FeatureData[Taxonomy]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98 reference taxonomy labels.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99 maxaccepts : Int % Range(1, None), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100 Maximum number of hits to keep for each query. Must be in range [0,
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101 infinity].
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102 perc_identity : Float % Range(0.0, 1.0, inclusive_end=True), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 Reject match if percent identity to query is lower. Must be in range
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104 [0.0, 1.0].
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 strand : Str % Choices({'both', 'plus'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 Align against reference sequences in forward ("plus") or both
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107 directions ("both").
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 min_consensus : Float % Range(0.5, 1.0, inclusive_start=False, inclusive_end=True), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109 Minimum fraction of assignments must match top hit to be accepted as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 consensus assignment. Must be in range (0.5, 1.0].
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111 unassignable_label : Str, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 \
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 classification : FeatureData[Taxonomy]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 The resulting taxonomy classifications.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 </tool>