annotate qiime2/qiime_vsearch_uchime-denovo.xml @ 3:558645416841 draft

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