annotate qiime2/qiime_dada2_denoise-paired.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-paired" name="qiime dada2 denoise-paired" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Denoise and dereplicate paired-end sequences</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 qiime dada2 denoise-paired --i-demultiplexed-seqs=$idemultiplexedseqs --p-trunc-len-f="$ptrunclenf" --p-trunc-len-r="$ptrunclenr"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
10 #if $pmaxee:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
11 --p-max-ee=$pmaxee
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
12 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
13
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
14 #if $ptrimleftr:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15 --p-trim-left-r=$ptrimleftr
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
17
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
18 --o-table=otable
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
19
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20 #if $phashedfeatureids:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 --p-hashed-feature-ids
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 #else
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 --p-no-hashed-feature-ids
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 #set $pnthreads = '${GALAXY_SLOTS:-4}'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($pnthreads):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 --p-n-threads=$pnthreads
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 #if $ptrimleftf:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 --p-trim-left-f=$ptrimleftf
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 #if str($pchimeramethod) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 --p-chimera-method=$pchimeramethod
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 #if $pnreadslearn:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 --p-n-reads-learn=$pnreadslearn
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 --o-representative-sequences=orepresentativesequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 #if $ptruncq:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 --p-trunc-q=$ptruncq
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 --o-denoising-stats=odenoisingstats
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 #if $pminfoldparentoverabundance:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 --p-min-fold-parent-over-abundance=$pminfoldparentoverabundance
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 cp otable.qza $otable;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 cp odenoisingstats.qza $odenoisingstats;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62 cp orepresentativesequences.qza $orepresentativesequences;
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[PairedEndSequencesWithQuality] The paired-end demultiplexed sequences to be denoised. [required]" name="idemultiplexedseqs" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66 <param label="--p-trunc-len-f: Position at which forward read 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. After this parameter is applied there must still be at least a 20 nucleotide overlap between the forward and reverse reads. If 0 is provided, no truncation or length filtering will be performed [required]" name="ptrunclenf" optional="False" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-trunc-len-r: Position at which reverse read 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. After this parameter is applied there must still be at least a 20 nucleotide overlap between the forward and reverse reads. If 0 is provided, no truncation or length filtering will be performed [required]" name="ptrunclenr" optional="False" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-trim-left-f: Position at which forward read sequences should be trimmed due to low quality. This trims the 5' end of the input sequences, which will be the bases that were sequenced in the first cycles. [default: 0]" name="ptrimleftf" optional="True" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-trim-left-r: Position at which reverse read sequences should be trimmed due to low quality. This trims the 5' end of the input sequences, which will be the bases that were sequenced in the first cycles. [default: 0]" name="ptrimleftr" optional="True" type="integer" value="0"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 <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
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_f\` or \`trunc_len_r\` (depending on the direction of the read) it is discarded. [default: 2]" name="ptruncq" optional="True" type="integer" value="2"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 <param label="--p-chimera-method: The method used to remove chimeras. None:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 No chimera removal is performed. Pooled:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 All reads are pooled prior to chimera
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 detection. Consensus: Chimeras are
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 detected in samples individually, and
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 sequences found chimeric in a sufficient
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 fraction of samples are removed. [default:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 consensus]" name="pchimeramethod" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="pooled">pooled</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="consensus">consensus</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="none">none</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 <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
86 <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: 1000000]" name="pnreadslearn" optional="True" type="integer" value="1000000"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87 <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="False" type="boolean"/>
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}: table.qza" name="otable"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92 <data format="qza" label="${tool.name} on ${on_string}: representative-sequences.qza" name="orepresentativesequences"/>
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
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96 <help><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97 Denoise and dereplicate paired-end sequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98 --------------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100 This method denoises paired-end sequences, dereplicates them, and filters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101 chimeras.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 demultiplexed_seqs : SampleData[PairedEndSequencesWithQuality]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 The paired-end demultiplexed sequences to be denoised.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107 trunc_len_f : Int
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 Position at which forward read sequences should be truncated due to
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109 decrease in quality. This truncates the 3' end of the of the input
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 sequences, which will be the bases that were sequenced in the last
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111 cycles. Reads that are shorter than this value will be discarded. After
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 this parameter is applied there must still be at least a 20 nucleotide
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113 overlap between the forward and reverse reads. If 0 is provided, no
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 truncation or length filtering will be performed
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115 trunc_len_r : Int
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 Position at which reverse read sequences should be truncated due to
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 decrease in quality. This truncates the 3' end of the of the input
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118 sequences, which will be the bases that were sequenced in the last
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 cycles. Reads that are shorter than this value will be discarded. After
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 this parameter is applied there must still be at least a 20 nucleotide
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 overlap between the forward and reverse reads. If 0 is provided, no
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 truncation or length filtering will be performed
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 trim_left_f : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 Position at which forward read sequences should be trimmed due to low
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
125 quality. This trims the 5' end of the input sequences, which will be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
126 the bases that were sequenced in the first cycles.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
127 trim_left_r : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
128 Position at which reverse read sequences should be trimmed due to low
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
129 quality. This trims the 5' end of the input sequences, which will be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
130 the bases that were sequenced in the first cycles.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
131 max_ee : Float, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
132 Reads with number of expected errors higher than this value will be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
133 discarded.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
134 trunc_q : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
135 Reads are truncated at the first instance of a quality score less than
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
136 or equal to this value. If the resulting read is then shorter than
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
137 \`trunc_len_f\` or \`trunc_len_r\` (depending on the direction of the read)
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
138 it is discarded.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
139 chimera_method : Str % Choices({'consensus', 'none', 'pooled'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
140 The method used to remove chimeras. "none": No chimera removal is
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
141 performed. "pooled": All reads are pooled prior to chimera detection.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
142 "consensus": Chimeras are detected in samples individually, and
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
143 sequences found chimeric in a sufficient fraction of samples are
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
144 removed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
145 min_fold_parent_over_abundance : Float, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
146 The minimum abundance of potential parents of a sequence being tested
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
147 as chimeric, expressed as a fold-change versus the abundance of the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
148 sequence being tested. Values should be greater than or equal to 1
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
149 (i.e. parents should be more abundant than the sequence being tested).
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
150 This parameter has no effect if chimera_method is "none".
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
151 n_reads_learn : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
152 The number of reads to use when training the error model. Smaller
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
153 numbers will result in a shorter run time but a less reliable error
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
154 model.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
155 hashed_feature_ids : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
156 If true, the feature ids in the resulting table will be presented as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
157 hashes of the sequences defining each feature. The hash will always be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
158 the same for the same sequence so this allows feature tables to be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
159 merged across runs of this method. You should only merge tables if the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
160 exact same parameters are used for each run.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
161
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
162 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
163 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
164 table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
165 The resulting feature table.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
166 representative_sequences : FeatureData[Sequence]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
167 The resulting feature sequences. Each feature in the feature table will
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
168 be represented by exactly one sequence, and these sequences will be the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
169 joined paired-end sequences.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
170 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
171 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
172 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
173 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
174 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
175 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
176 </tool>