annotate qiime2/qiime_feature-classifier_classify-consensus-vsearch.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents de4c22a52df4
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_feature-classifier_classify-consensus-vsearch" name="qiime feature-classifier classify-consensus-vsearch" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - VSEARCH consensus taxonomy classifier</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 feature-classifier classify-consensus-vsearch
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-query=$iquery
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reference-reads=$ireferencereads
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str( $id_to_taxonomy_fp.selector ) == 'history'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $tax = $id_to_taxonomy_fp.taxonomy_fp
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --i-reference-taxonomy '$tax'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #else:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #set $tax = $id_to_taxonomy_fp.taxonomy_fp.fields.path
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --i-reference-taxonomy '$tax'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
23 #if $psearchexact:
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
24 --p-search-exact
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
25 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
26
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
27
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
28 #if $ptophitsonly:
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
29 --p-top-hits-only
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
30 #end if
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
31
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
32
4
florianbegusch
parents: 0
diff changeset
33
6
florianbegusch
parents: 4
diff changeset
34 #if str($pmaxaccepts):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-maxaccepts=$pmaxaccepts
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
6
florianbegusch
parents: 4
diff changeset
38 #if str($ppercidentity):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --p-perc-identity=$ppercidentity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
6
florianbegusch
parents: 4
diff changeset
42 #if str($pquerycov):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --p-query-cov=$pquerycov
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #if str($pstrand) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 --p-strand=$pstrand
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49
6
florianbegusch
parents: 4
diff changeset
50 #if str($pminconsensus):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 --p-min-consensus=$pminconsensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53
4
florianbegusch
parents: 0
diff changeset
54
florianbegusch
parents: 0
diff changeset
55
florianbegusch
parents: 0
diff changeset
56
florianbegusch
parents: 0
diff changeset
57
florianbegusch
parents: 0
diff changeset
58 #if '__sq__' in str($punassignablelabel):
florianbegusch
parents: 0
diff changeset
59 #set $punassignablelabel_temp = $punassignablelabel.replace('__sq__', "'")
florianbegusch
parents: 0
diff changeset
60 #set $punassignablelabel = $punassignablelabel_temp
florianbegusch
parents: 0
diff changeset
61 #end if
florianbegusch
parents: 0
diff changeset
62
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 #if str($punassignablelabel):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 --p-unassignable-label="$punassignablelabel"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66
4
florianbegusch
parents: 0
diff changeset
67
florianbegusch
parents: 0
diff changeset
68
florianbegusch
parents: 0
diff changeset
69
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 #set $pthreads = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 #if str($pthreads):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 --p-threads="$pthreads"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 --o-classification=oclassification
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
76
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 cp oclassification.qza $oclassification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <param format="qza,no_unzip.zip" label="--i-query: ARTIFACT FeatureData[Sequence] Sequences to classify taxonomically. [required]" name="iquery" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <param format="qza,no_unzip.zip" label="--i-reference-reads: ARTIFACT FeatureData[Sequence] reference sequences. [required]" name="ireferencereads" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <conditional name="id_to_taxonomy_fp" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <param name="selector" type="select" label="Reference taxonomy to query">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="cached">Public databases</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="history">Databases from your history</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <when value="cached">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <options from_data_table="qiime_taxonomy" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <when value="history">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 </conditional>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <param label="--p-maxaccepts: INTEGER Maximum number of hits to keep for each query. Set Range(0, None) to 0 to keep all hits > perc-identity similarity. Must be in range [0, infinity]. [default: 10]" name="pmaxaccepts" optional="True" type="integer" min="0" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <param label="--p-perc-identity: PROPORTION Range(0.0, 1.0, inclusive_end=True) 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" min="0" max="1" exclude_max="False" value="0.8"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <param label="--p-query-cov: PROPORTION Range(0.0, 1.0, inclusive_end=True) Reject match if query alignment coverage per high-scoring pair is lower. Must be in range [0.0, 1.0]. [default: 0.8]" name="pquerycov" optional="True" type="float" min="0" max="1" exclude_max="False" value="0.8"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <param label="--p-strand: Align against reference sequences in forward ('plus') or both directions ('both'). [default: 'both']" name="pstrand" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <option value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <option selected="True" value="both">both</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <option value="plus">plus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <param label="--p-min-consensus: NUMBER Range(0.5, 1.0, inclusive_start=False, inclusive_end=True) 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" min="0.5" max="1" exclude_min="True" exclude_max="False" value="0.51"/>
4
florianbegusch
parents: 0
diff changeset
108 <param label="--p-unassignable-label: TEXT [default: 'Unassigned']" name="punassignablelabel" optional="True" type="text" value="Unassigned"/>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
109
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
110
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
111 <param label="--p-search-exact: Search for exact full-length matches to the query sequences. Only 100% exact matches are reported and this command is much faster than the default. If True, the perc-identity and query-cov settings are ignored. Note: query and reference reads must be trimmed to the exact same DNA locus (e.g., primer site) because only exact matches will be reported. [default: False]" name="psearchexact" selected="False" type="boolean"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
112 <param label="--p-top-hits-only: Only the top hits between the query and reference sequence sets are reported. For each query, the top hit is the one presenting the highest percentage of identity. Multiple equally scored top hits will be used for consensus taxonomic assignment if maxaccepts is greater than 1. [default: False]" name="ptophitsonly" selected="False" type="boolean"/>
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
113
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 <help><![CDATA[
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
119 VSEARCH-based consensus taxonomy classifier
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 Assign taxonomy to query sequences using VSEARCH. Performs VSEARCH global
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 alignment between query and reference_reads, then assigns consensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 taxonomy to each query sequence from among maxaccepts top hits,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 min_consensus of which share that taxonomic assignment. Unlike classify-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 consensus-blast, this method searches the entire reference database before
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 choosing the top N hits, not the first N hits.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 query : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 Sequences to classify taxonomically.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 reference_reads : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 reference sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 reference_taxonomy : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 reference taxonomy labels.
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
136 maxaccepts : Int % Range(1, None) | Str % Choices('all'), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
137 Maximum number of hits to keep for each query. Set to "all" to keep all
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
138 hits > perc_identity similarity.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 perc_identity : Float % Range(0.0, 1.0, inclusive_end=True), optional
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
140 Reject match if percent identity to query is lower.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 query_cov : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 Reject match if query alignment coverage per high-scoring pair is
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
143 lower.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 strand : Str % Choices('both', 'plus'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 Align against reference sequences in forward ("plus") or both
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 directions ("both").
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 min_consensus : Float % Range(0.5, 1.0, inclusive_start=False, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 Minimum fraction of assignments must match top hit to be accepted as
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
149 consensus assignment.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 unassignable_label : Str, optional
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
151 search_exact : Bool, optional
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
152 Search for exact full-length matches to the query sequences. Only 100%
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
153 exact matches are reported and this command is much faster than the
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
154 default. If True, the perc_identity and query_cov settings are ignored.
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
155 Note: query and reference reads must be trimmed to the exact same DNA
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
156 locus (e.g., primer site) because only exact matches will be reported.
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
157 top_hits_only : Bool, optional
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
158 Only the top hits between the query and reference sequence sets are
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
159 reported. For each query, the top hit is the one presenting the highest
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
160 percentage of identity. Multiple equally scored top hits will be used
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
161 for consensus taxonomic assignment if maxaccepts is greater than 1.
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
162 threads : Int % Range(1, None), optional
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
163 Number of threads to use for job parallelization.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 classification : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 The resulting taxonomy classifications.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
173 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
174 </tool>