annotate qiime2/qiime_dada2_denoise-paired.xml @ 0:370e0b6e9826 draft

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