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