annotate qiime2/qiime_dada2_denoise-pyro.xml @ 0:51b9b6b57732 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 05:21:07 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_dada2_denoise-pyro" name="qiime dada2 denoise-pyro" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Denoise and dereplicate single-end pyrosequences</description>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
8
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9 qiime dada2 denoise-pyro --p-trunc-len="$ptrunclen" --i-demultiplexed-seqs=$idemultiplexedseqs
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
10
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
11 #if $pnreadslearn:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
12 --p-n-reads-learn=$pnreadslearn
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
14
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pchimeramethod) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16 --p-chimera-method=$pchimeramethod
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
18
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
19 --o-representative-sequences=orepresentativesequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pminfoldparentoverabundance:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 --p-min-fold-parent-over-abundance=$pminfoldparentoverabundance
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 #if $pmaxlen:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 --p-max-len=$pmaxlen
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 --o-table=otable
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 #if $ptruncq:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 --p-trunc-q=$ptruncq
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 #set $pnthreads = '${GALAXY_SLOTS:-4}'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 #if str($pnthreads):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 --p-n-threads="$pnthreads"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 #if $ptrimleft:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 --p-trim-left=$ptrimleft
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 #if $phashedfeatureids:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 --p-hashed-feature-ids
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 #if $pmaxee:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 --p-max-ee=$pmaxee
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58 --o-denoising-stats=odenoisingstats;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 cp orepresentativesequences.qza $orepresentativesequences;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 cp otable.qza $otable;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62 cp odenoisingstats.qza $odenoisingstats;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 ]]></command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 <param format="qza,no_unzip.zip" label="--i-demultiplexed-seqs: SampleData[SequencesWithQuality] The single-end demultiplexed pyrosequencing sequences (e.g. 454, IonTorrent) to be denoised. [required]" name="idemultiplexedseqs" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-trunc-len: Position at which sequences should be truncated due to decrease in quality. This truncates the 3' end of the of the input sequences, which will be the bases that were sequenced in the last cycles. Reads that are shorter than this value will be discarded. If 0 is provided, no truncation or length filtering will be performed [required]" name="ptrunclen" optional="False" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-trim-left: Position at which sequences should be trimmed due to low quality. This trims the 5' end of the of the input sequences, which will be the bases that were sequenced in the first cycles. [default: 0]" name="ptrimleft" optional="True" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-max-ee: Reads with number of expected errors higher than this value will be discarded. [default: 2.0]" name="pmaxee" optional="True" type="float" value="2.0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-trunc-q: Reads are truncated at the first instance of a quality score less than or equal to this value. If the resulting read is then shorter than `trunc_len`, it is discarded. [default: 2]" name="ptruncq" optional="True" type="integer" value="2"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 <param label="--p-max-len: Remove reads prior to trimming or truncation which are longer than this value. If 0 is provided no reads will be removed based on length. [default: 0]" name="pmaxlen" optional="True" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 <param label="--p-chimera-method: " name="pchimeramethod" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="consensus">consensus</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="none">none</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="pooled">pooled</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <param label="--p-min-fold-parent-over-abundance: The minimum abundance of potential parents of a sequence being tested as chimeric, expressed as a fold-change versus the abundance of the sequence being tested. Values should be greater than or equal to 1 (i.e. parents should be more abundant than the sequence being tested). This parameter has no effect if chimera_method is 'none'. [default: 1.0]" name="pminfoldparentoverabundance" optional="True" type="float" value="1.0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 <param label="--p-n-reads-learn: The number of reads to use when training the error model. Smaller numbers will result in a shorter run time but a less reliable error model. [default: 250000]" name="pnreadslearn" optional="True" type="integer" value="250000"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 <param label="--p-hashed-feature-ids: --p-no-hashed-feature-ids If true, the feature ids in the resulting table will be presented as hashes of the sequences defining each feature. The hash will always be the same for the same sequence so this allows feature tables to be merged across runs of this method. You should only merge tables if the exact same parameters are used for each run. [default: True]" name="phashedfeatureids" checked="True" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 <data format="qza" label="${tool.name} on ${on_string}: representative-sequences.qza" name="orepresentativesequences"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92 <data format="qza" label="${tool.name} on ${on_string}: table.qza" name="otable"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 <data format="qza" label="${tool.name} on ${on_string}: denoising-stats.qza" name="odenoisingstats"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
95 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97 Denoise and dereplicate single-end pyrosequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98 -------------------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99 This method denoises single-end pyrosequencing sequences, dereplicates
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100 them, and filters chimeras.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104 demultiplexed_seqs : SampleData[SequencesWithQuality]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 The single-end demultiplexed pyrosequencing sequences (e.g. 454,
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 IonTorrent) to be denoised.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107 trunc_len : Int
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 Position at which sequences should be truncated due to decrease in
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109 quality. This truncates the 3' end of the of the input sequences, which
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 will be the bases that were sequenced in the last cycles. Reads that
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111 are shorter than this value will be discarded. If 0 is provided, no
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 truncation or length filtering will be performed
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113 trim_left : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 Position at which sequences should be trimmed due to low quality. This
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115 trims the 5' end of the of the input sequences, which will be the bases
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 that were sequenced in the first cycles.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 max_ee : Float, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118 Reads with number of expected errors higher than this value will be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 discarded.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 trunc_q : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 Reads are truncated at the first instance of a quality score less than
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 or equal to this value. If the resulting read is then shorter than
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 `trunc_len`, it is discarded.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 max_len : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
125 Remove reads prior to trimming or truncation which are longer than this
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
126 value. If 0 is provided no reads will be removed based on length.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
127 chimera_method : Str % Choices({'consensus', 'none', 'pooled'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
128 The method used to remove chimeras. "none": No chimera removal is
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
129 performed. "pooled": All reads are pooled prior to chimera detection.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
130 "consensus": Chimeras are detected in samples individually, and
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
131 sequences found chimeric in a sufficient fraction of samples are
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
132 removed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
133 min_fold_parent_over_abundance : Float, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
134 The minimum abundance of potential parents of a sequence being tested
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
135 as chimeric, expressed as a fold-change versus the abundance of the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
136 sequence being tested. Values should be greater than or equal to 1
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
137 (i.e. parents should be more abundant than the sequence being tested).
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
138 This parameter has no effect if chimera_method is "none".
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
139 n_threads : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
140 The number of threads to use for multithreaded processing. If 0 is
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
141 provided, all available cores will be used.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
142 n_reads_learn : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
143 The number of reads to use when training the error model. Smaller
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
144 numbers will result in a shorter run time but a less reliable error
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
145 model.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
146 hashed_feature_ids : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
147 If true, the feature ids in the resulting table will be presented as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
148 hashes of the sequences defining each feature. The hash will always be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
149 the same for the same sequence so this allows feature tables to be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
150 merged across runs of this method. You should only merge tables if the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
151 exact same parameters are used for each run.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
152
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
153 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
154 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
155 table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
156 The resulting feature table.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
157 representative_sequences : FeatureData[Sequence]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
158 The resulting feature sequences. Each feature in the feature table will
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
159 be represented by exactly one sequence.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
160 denoising_stats : SampleData[DADA2Stats]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
161 \
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
162 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
163 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
164 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
165 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
166 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
167 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
168 </tool>