annotate qiime2/qiime_dada2_denoise-single.xml @ 0:51b9b6b57732 draft

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