annotate qiime2/qiime_vsearch_uchime-ref.xml @ 0:370e0b6e9826 draft

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 03:05:17 -0400
parents
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-ref" name="qiime vsearch uchime-ref" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Reference-based 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-ref
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 --i-reference-sequences=$ireferencesequences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if $pdn:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-dn=$pdn
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if $pmindiffs:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-mindiffs=$pmindiffs
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if $pmindiv:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-mindiv=$pmindiv
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if $pminh:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-minh=$pminh
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if $pxn:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-xn=$pxn
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #set $pthreads = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($pthreads):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-threads="$pthreads"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-chimeras=ochimeras
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --o-nonchimeras=ononchimeras
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --o-stats=ostats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 cp ochimeras.qza $ochimeras;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 cp ononchimeras.qza $ononchimeras;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 cp ostats.qza $ostats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <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
49 <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
50 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <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
52 <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
53 <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
54 <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
55 <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_min="True" value="8.0"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <data format="qza" label="${tool.name} on ${on_string}: chimeras.qza" name="ochimeras"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <data format="qza" label="${tool.name} on ${on_string}: nonchimeras.qza" name="ononchimeras"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <data format="qza" label="${tool.name} on ${on_string}: stats.qza" name="ostats"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 Reference-based chimera filtering with vsearch.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 ###############################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 Apply the vsearch uchime_ref method to identify chimeric feature sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 The results of this method can be used to filter chimeric features from the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 corresponding feature table. For additional details, please refer to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 vsearch documentation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 The feature sequences to be chimera-checked.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 Feature table (used for computing total feature abundances).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 reference_sequences : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 The non-chimeric reference sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 dn : Float % Range(0.0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 No vote pseudo-count, corresponding to the parameter n in the chimera
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 scoring function.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 mindiffs : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Minimum number of differences per segment.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 mindiv : Float % Range(0.0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Minimum divergence from closest parent.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 minh : Float % Range(0.0, 1.0, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 Minimum score (h). Increasing this value tends to reduce the number of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 false positives and to decrease sensitivity.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 xn : Float % Range(1.0, None, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 No vote weight, corresponding to the parameter beta in the scoring
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 function.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 threads : Int % Range(0, 256, inclusive_end=True), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 The number of threads to use for computation. Passing 0 will launch one
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 thread per CPU core.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 chimeras : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 The chimeric sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 nonchimeras : FeatureData[Sequence]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 The non-chimeric sequences.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 stats : UchimeStats
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Summary statistics from chimera checking.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 </tool>