annotate qiime2/qiime_vsearch_uchime-denovo.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents f190567fe3f6
children
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" ?>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
2 <tool id="qiime_vsearch_uchime-denovo" name="qiime vsearch uchime-denovo"
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
4 <description>De novo chimera filtering with vsearch.</description>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
8 <command><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime vsearch uchime-denovo
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-sequences=$isequences
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
12
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 --p-dn=$pdn
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 --p-mindiffs=$pmindiffs
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 --p-mindiv=$pmindiv
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 --p-minh=$pminh
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
23 --p-xn=$pxn
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --o-chimeras=ochimeras
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
26
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --o-nonchimeras=ononchimeras
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
28
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --o-stats=ostats
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
30
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
31 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
32 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
33 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
34
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 cp ostats.qza $ostats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
38 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
41 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
42 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
43 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
45 <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" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
46 <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="None" min="1.0" name="pxn" optional="True" type="float" value="8.0" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
47 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
48
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
49 </inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
50
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
51 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52 <data format="qza" label="${tool.name} on ${on_string}: chimeras.qza" name="ochimeras" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 <data format="qza" label="${tool.name} on ${on_string}: nonchimeras.qza" name="ononchimeras" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54 <data format="qza" label="${tool.name} on ${on_string}: stats.qza" name="ostats" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
56 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
58 <help><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 De novo chimera filtering with vsearch.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60 ###############################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Apply the vsearch uchime_denovo method to identify chimeric feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 sequences. The results of this method can be used to filter chimeric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 features from the corresponding feature table. For additional details,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 please refer to the vsearch documentation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 The feature sequences to be chimera-checked.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 Feature table (used for computing total feature abundances).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 dn : Float % Range(0.0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 No vote pseudo-count, corresponding to the parameter n in the chimera
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 scoring function.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 mindiffs : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Minimum number of differences per segment.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 mindiv : Float % Range(0.0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Minimum divergence from closest parent.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 minh : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Minimum score (h). Increasing this value tends to reduce the number of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 false positives and to decrease sensitivity.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 xn : Float % Range(1.0, None, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 No vote weight, corresponding to the parameter beta in the scoring
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 function.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 chimeras : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 The chimeric sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 nonchimeras : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 The non-chimeric sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 stats : UchimeStats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 Summary statistics from chimera checking.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
95 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
96 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
98 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
99 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
100 </tool>