annotate qiime_vsearch_uchime-ref.xml @ 0:09b7bcb72fa7 draft

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