annotate qiime2/qiime_vsearch_uchime-ref.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_vsearch_uchime-ref" name="qiime vsearch uchime-ref"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Reference-based chimera filtering with vsearch.</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime vsearch uchime-ref
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-sequences=$isequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --i-reference-sequences=$ireferencesequences
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --p-dn=$pdn
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 --p-mindiffs=$pmindiffs
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 --p-mindiv=$pmindiv
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 --p-minh=$pminh
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 --p-xn=$pxn
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 --p-threads=$pthreads
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 --o-chimeras=ochimeras
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 --o-nonchimeras=ononchimeras
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 --o-stats=ostats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 cp ostats.qza $ostats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 <param format="qza,no_unzip.zip" label="--i-sequences: ARTIFACT FeatureData[Sequence] The feature sequences to be chimera-checked. [required]" name="isequences" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table (used for computing total feature abundances). [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 <param format="qza,no_unzip.zip" label="--i-reference-sequences: ARTIFACT FeatureData[Sequence] The non-chimeric reference sequences. [required]" name="ireferencesequences" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 <param label="--p-dn: NUMBER No vote pseudo-count, corresponding to the Range(0.0, None) parameter n in the chimera scoring function. [default: 1.4]" min="0.0" name="pdn" optional="True" type="float" value="1.4" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-mindiffs: INTEGER Minimum number of differences per segment. Range(1, None) [default: 3]" min="1" name="pmindiffs" optional="True" type="integer" value="3" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <param label="--p-mindiv: NUMBER Minimum divergence from closest parent. Range(0.0, None) [default: 0.8]" min="0.0" name="pmindiv" optional="True" type="float" value="0.8" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 <param exclude_max="False" label="--p-minh: PROPORTION Range(0.0, 1.0, inclusive_end=True) Minimum score (h). Increasing this value tends to reduce the number of false positives and to decrease sensitivity. [default: 0.28]" max="1.0" min="0.0" name="pminh" optional="True" type="float" value="0.28" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 <param exclude_min="True" label="--p-xn: NUMBER Range(1.0, None, inclusive_start=False) No vote weight, corresponding to the parameter beta in the scoring function. [default: 8.0]" max="20.0" min="1.0" name="pxn" optional="True" type="float" value="8.0" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 <data format="qza" label="${tool.name} on ${on_string}: chimeras.qza" name="ochimeras" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 <data format="qza" label="${tool.name} on ${on_string}: nonchimeras.qza" name="ononchimeras" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 <data format="qza" label="${tool.name} on ${on_string}: stats.qza" name="ostats" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 Reference-based chimera filtering with vsearch.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 Apply the vsearch uchime_ref method to identify chimeric feature sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 The results of this method can be used to filter chimeric features from the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 corresponding feature table. For additional details, please refer to the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 vsearch documentation.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 sequences : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 The feature sequences to be chimera-checked.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 Feature table (used for computing total feature abundances).
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 reference_sequences : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 The non-chimeric reference sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 dn : Float % Range(0.0, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 No vote pseudo-count, corresponding to the parameter n in the chimera
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 scoring function.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 mindiffs : Int % Range(1, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 Minimum number of differences per segment.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 mindiv : Float % Range(0.0, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 Minimum divergence from closest parent.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 minh : Float % Range(0.0, 1.0, inclusive_end=True), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88 Minimum score (h). Increasing this value tends to reduce the number of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 false positives and to decrease sensitivity.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 xn : Float % Range(1.0, None, inclusive_start=False), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 No vote weight, corresponding to the parameter beta in the scoring
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 function.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 threads : Int % Range(0, 256, inclusive_end=True), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 The number of threads to use for computation. Passing 0 will launch one
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 thread per CPU core.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99 chimeras : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 The chimeric sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 nonchimeras : FeatureData[Sequence]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 The non-chimeric sequences.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 stats : UchimeStats
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 Summary statistics from chimera checking.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
109 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
110 </tool>