annotate qiime2/qiime_feature-classifier_classify-consensus-vsearch.xml @ 6:de4c22a52df4 draft

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:46:48 -0400
parents 914fa4daf16a
children f190567fe3f6
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" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-classifier_classify-consensus-vsearch" name="qiime feature-classifier classify-consensus-vsearch" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - VSEARCH consensus taxonomy classifier</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
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
4
florianbegusch
parents: 0
diff changeset
23
6
florianbegusch
parents: 4
diff changeset
24 #if str($pmaxaccepts):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-maxaccepts=$pmaxaccepts
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
6
florianbegusch
parents: 4
diff changeset
28 #if str($ppercidentity):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-perc-identity=$ppercidentity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
6
florianbegusch
parents: 4
diff changeset
32 #if str($pquerycov):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --p-query-cov=$pquerycov
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #if str($pstrand) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --p-strand=$pstrand
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39
6
florianbegusch
parents: 4
diff changeset
40 #if str($pminconsensus):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --p-min-consensus=$pminconsensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
4
florianbegusch
parents: 0
diff changeset
44
florianbegusch
parents: 0
diff changeset
45
florianbegusch
parents: 0
diff changeset
46
florianbegusch
parents: 0
diff changeset
47
florianbegusch
parents: 0
diff changeset
48 #if '__sq__' in str($punassignablelabel):
florianbegusch
parents: 0
diff changeset
49 #set $punassignablelabel_temp = $punassignablelabel.replace('__sq__', "'")
florianbegusch
parents: 0
diff changeset
50 #set $punassignablelabel = $punassignablelabel_temp
florianbegusch
parents: 0
diff changeset
51 #end if
florianbegusch
parents: 0
diff changeset
52
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 #if str($punassignablelabel):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 --p-unassignable-label="$punassignablelabel"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56
4
florianbegusch
parents: 0
diff changeset
57
florianbegusch
parents: 0
diff changeset
58
florianbegusch
parents: 0
diff changeset
59
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 #set $pthreads = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 #if str($pthreads):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 --p-threads="$pthreads"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 --o-classification=oclassification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 cp oclassification.qza $oclassification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <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
71 <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
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <conditional name="id_to_taxonomy_fp" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <param name="selector" type="select" label="Reference taxonomy to query">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="cached">Public databases</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="history">Databases from your history</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <when value="cached">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <options from_data_table="qiime_taxonomy" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <when value="history">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 </conditional>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <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
89 <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
90 <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
91 <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
92 <option value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <option selected="True" value="both">both</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <option value="plus">plus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <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
97 <param label="--p-unassignable-label: TEXT [default: 'Unassigned']" name="punassignablelabel" optional="True" type="text" value="Unassigned"/>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 VSEARCH consensus taxonomy classifier
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 #####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 Assign taxonomy to query sequences using VSEARCH. Performs VSEARCH global
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 alignment between query and reference_reads, then assigns consensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 taxonomy to each query sequence from among maxaccepts top hits,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 min_consensus of which share that taxonomic assignment. Unlike classify-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 consensus-blast, this method searches the entire reference database before
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 choosing the top N hits, not the first N hits.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 query : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 Sequences to classify taxonomically.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 reference_reads : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 reference sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 reference_taxonomy : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 reference taxonomy labels.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 maxaccepts : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 Maximum number of hits to keep for each query. Set to 0 to keep all
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 hits > perc_identity similarity. Must be in range [0, infinity].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 perc_identity : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 Reject match if percent identity to query is lower. Must be in range
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 [0.0, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 query_cov : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 Reject match if query alignment coverage per high-scoring pair is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 lower. Must be in range [0.0, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 strand : Str % Choices('both', 'plus'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 Align against reference sequences in forward ("plus") or both
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 directions ("both").
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 min_consensus : Float % Range(0.5, 1.0, inclusive_start=False, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 Minimum fraction of assignments must match top hit to be accepted as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 consensus assignment. Must be in range (0.5, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 unassignable_label : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 \
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 classification : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 The resulting taxonomy classifications.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 </tool>