annotate qiime2-2020.8/qiime_dada2_denoise-single.xml @ 20:d93d8888f0b0 draft

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