annotate qiime2/qiime_feature-classifier_classify-consensus-blast.xml @ 4:914fa4daf16a draft

Fixes
author florianbegusch
date Wed, 31 Jul 2019 03:06:00 -0400
parents 370e0b6e9826
children de4c22a52df4
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-blast" name="qiime feature-classifier classify-consensus-blast" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - BLAST+ 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-blast
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 #if str( $id_to_taxonomy_fp.selector ) == 'history'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #set $tax = $id_to_taxonomy_fp.taxonomy_fp
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --i-reference-taxonomy '$tax'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #else:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $tax = $id_to_taxonomy_fp.taxonomy_fp.fields.path
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --i-reference-taxonomy '$tax'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if $pmaxaccepts:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-maxaccepts=$pmaxaccepts
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if $ppercidentity:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-perc-identity=$ppercidentity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if $pquerycov:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-query-cov=$pquerycov
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #if str($pstrand) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-strand=$pstrand
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #if $pevalue:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --p-evalue=$pevalue
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #if $pminconsensus:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --p-min-consensus=$pminconsensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
4
florianbegusch
parents: 0
diff changeset
46
florianbegusch
parents: 0
diff changeset
47
florianbegusch
parents: 0
diff changeset
48
florianbegusch
parents: 0
diff changeset
49
florianbegusch
parents: 0
diff changeset
50 #if '__sq__' in str($punassignablelabel):
florianbegusch
parents: 0
diff changeset
51 #set $punassignablelabel_temp = $punassignablelabel.replace('__sq__', "'")
florianbegusch
parents: 0
diff changeset
52 #set $punassignablelabel = $punassignablelabel_temp
florianbegusch
parents: 0
diff changeset
53 #end if
florianbegusch
parents: 0
diff changeset
54
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 #if str($punassignablelabel):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 --p-unassignable-label="$punassignablelabel"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
4
florianbegusch
parents: 0
diff changeset
59
florianbegusch
parents: 0
diff changeset
60
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 --o-classification=oclassification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 cp oclassification.qza $oclassification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <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
67 <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
68
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <conditional name="id_to_taxonomy_fp" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param name="selector" type="select" label="Reference taxonomy to query">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="cached">Public databases</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="history">Databases from your history</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <when value="cached">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <param argument="--taxonomy_fp" label="Reference taxonomy" type="select" optional="True">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <options from_data_table="qiime_taxonomy" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <when value="history">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <param argument="--taxonomy_fp" type="data" format="qza,no_unzip.zip" label="Reference databases" optional="True" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 </when>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 </conditional>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <param label="--p-maxaccepts: INTEGER Maximum number of hits to keep for each query. Must Range(1, None) be in range [1, infinity]. BLAST will choose the first N hits in the reference database that exceed perc-identity similarity to query. [default: 10]" name="pmaxaccepts" optional="True" type="integer" min="1" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <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
86 <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. Note: this uses blastn's qcov_hsp_perc parameter, and may not behave identically to the query-cov parameter used by classify-consensus-vsearch. Must be in range [0.0, 1.0]. [default: 0.8]" name="pquerycov" optional="True" min="0" max="1" exclude_max="False" type="float" value="0.8"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <param label="--p-strand: " name="pstrand" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="both">both</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <option value="plus">plus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <option value="minus">minus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <param label="--p-evalue: NUMBER BLAST expectation value (E) threshold for saving hits. [default: 0.001]" name="pevalue" optional="True" type="float" value="0.001"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <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
95 <param label="--p-unassignable-label: TEXT [default: 'Unassigned']" name="punassignablelabel" optional="True" type="text" value="Unassigned"/>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 BLAST+ consensus taxonomy classifier
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 ####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Assign taxonomy to query sequences using BLAST+. Performs BLAST+ local
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 alignment between query and reference_reads, then assigns consensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 taxonomy to each query sequence from among maxaccepts hits, min_consensus
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 of which share that taxonomic assignment. Note that maxaccepts selects the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 first N hits with > perc_identity similarity to query, not the top N
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 matches. For top N hits, use classify-consensus-vsearch.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 query : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 Sequences to classify taxonomically.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 reference_reads : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 reference sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 reference_taxonomy : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 reference taxonomy labels.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 maxaccepts : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 Maximum number of hits to keep for each query. Must be in range [1,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 infinity]. BLAST will choose the first N hits in the reference database
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 that exceed perc_identity similarity to query.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 perc_identity : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 Reject match if percent identity to query is lower. Must be in range
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 [0.0, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 query_cov : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 Reject match if query alignment coverage per high-scoring pair is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 lower. Note: this uses blastn's qcov_hsp_perc parameter, and may not
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 behave identically to the query_cov parameter used by classify-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 consensus-vsearch. Must be in range [0.0, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 strand : Str % Choices('both', 'plus', 'minus'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 Align against reference sequences in forward ("plus"), reverse
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 ("minus"), or both directions ("both").
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 evalue : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 BLAST expectation value (E) threshold for saving hits.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 min_consensus : Float % Range(0.5, 1.0, inclusive_start=False, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 Minimum fraction of assignments must match top hit to be accepted as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 consensus assignment. Must be in range (0.5, 1.0].
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 unassignable_label : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 \
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 classification : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 Taxonomy classifications of query sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 </tool>