annotate qiime2/qiime_dada2_denoise-pyro.xml @ 11:ea7a1c6be3c4 draft

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