annotate qiime2/qiime_dada2_denoise-single.xml @ 1:255f48db74f8 draft

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