annotate qiime2/qiime_dada2_denoise-single.xml @ 29:3ba9833030c1 draft

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