annotate qiime2-2020.8/qiime_cutadapt_trim-paired.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_cutadapt_trim-paired" name="qiime cutadapt trim-paired"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Find and remove adapters in demultiplexed paired-end sequences.</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime cutadapt trim-paired
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-demultiplexed-sequences=$idemultiplexedsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 --p-cores=$pcores
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($padapterf):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16 --p-adapter-f=$padapterf
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($pfrontf):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 --p-front-f=$pfrontf
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 #if '__ob__' in str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22 #set $panywheref_temp = $panywheref.replace('__ob__', '[')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 #set $panywheref = $panywheref_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25 #if '__cb__' in str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 #set $panywheref_temp = $panywheref.replace('__cb__', ']')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 #set $panywheref = $panywheref_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 #if 'X' in str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 #set $panywheref_temp = $panywheref.replace('X', '\\')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31 #set $panywheref = $panywheref_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 #if '__sq__' in str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 #set $panywheref_temp = $panywheref.replace('__sq__', "'")
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 #set $panywheref = $panywheref_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 #if '__db__' in str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38 #set $panywheref_temp = $panywheref.replace('__db__', '"')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 #set $panywheref = $panywheref_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42 #if str($panywheref):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 --p-anywhere-f=$panywheref
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 #if str($padapterr):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 --p-adapter-r=$padapterr
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 #if str($pfrontr):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50 --p-front-r=$pfrontr
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 #if '__ob__' in str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53 #set $panywherer_temp = $panywherer.replace('__ob__', '[')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 #set $panywherer = $panywherer_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 #if '__cb__' in str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 #set $panywherer_temp = $panywherer.replace('__cb__', ']')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 #set $panywherer = $panywherer_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 #if 'X' in str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 #set $panywherer_temp = $panywherer.replace('X', '\\')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 #set $panywherer = $panywherer_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 #if '__sq__' in str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 #set $panywherer_temp = $panywherer.replace('__sq__', "'")
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 #set $panywherer = $panywherer_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68 #if '__db__' in str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 #set $panywherer_temp = $panywherer.replace('__db__', '"')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 #set $panywherer = $panywherer_temp
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 #if str($panywherer):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 --p-anywhere-r=$panywherer
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 --p-error-rate=$perrorrate
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 #if $pnoindels:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
80 --p-no-indels
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
81 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
82
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
83 --p-times=$ptimes
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
84
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
85 --p-overlap=$poverlap
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
86
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
87 #if $pmatchreadwildcards:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
88 --p-match-read-wildcards
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
89 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
90
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
91 #if $pnomatchadapterwildcards:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
92 --p-no-match-adapter-wildcards
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
93 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
94
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
95 --p-minimum-length=$pminimumlength
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
96
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
97 #if $pdiscarduntrimmed:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
98 --p-discard-untrimmed
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
99 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
100
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
101 --o-trimmed-sequences=otrimmedsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
102
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
103 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
104 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
105 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
106
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
107 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
108 cp otrimmedsequences.qza $otrimmedsequences
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
109
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
110 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
111 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
112 <param format="qza,no_unzip.zip" label="--i-demultiplexed-sequences: ARTIFACT SampleData[PairedEndSequencesWithQuality] The paired-end sequences to be trimmed. [required]" name="idemultiplexedsequences" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
113 <param label="--p-adapter-f: TEXT... Sequence of an adapter ligated to the 3\' end. The List[Str] adapter and any subsequent bases are trimmed. If a `$` is appended, the adapter is only found if it is at the end of the read. Search in forward read. If your sequence of interest is \'framed\' by a 5\' and a 3\' adapter, use this parameter to define a \'linked\' primer - see https://cutadapt.readthedocs.io for complete details. [optional]" name="padapterf" optional="False" type="text" value="False" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
114 <param label="--p-front-f: TEXT... Sequence of an adapter ligated to the 5\' end. The List[Str] adapter and any preceding bases are trimmed. Partial matches at the 5\' end are allowed. If a `^` character is prepended, the adapter is only found if it is at the beginning of the read. Search in forward read. [optional]" name="pfrontf" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
115 <param label="--p-anywhere-f: TEXT... Sequence of an adapter that may be ligated to the List[Str] 5\' or 3\' end. Both types of matches as described under `adapter` and `front` are allowed. If the first base of the read is part of the match, the behavior is as with `front`, otherwise as with `adapter`. This option is mostly for rescuing failed library preparations - do not use if you know which end your adapter was ligated to. Search in forward read. [optional]" name="panywheref" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
116 <param label="--p-adapter-r: TEXT... Sequence of an adapter ligated to the 3\' end. The List[Str] adapter and any subsequent bases are trimmed. If a `$` is appended, the adapter is only found if it is at the end of the read. Search in reverse read. If your sequence of interest is \'framed\' by a 5\' and a 3\' adapter, use this parameter to define a \'linked\' primer - see https://cutadapt.readthedocs.io for complete details. [optional]" name="padapterr" optional="False" type="text" value="False" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
117 <param label="--p-front-r: TEXT... Sequence of an adapter ligated to the 5\' end. The List[Str] adapter and any preceding bases are trimmed. Partial matches at the 5\' end are allowed. If a `^` character is prepended, the adapter is only found if it is at the beginning of the read. Search in reverse read. [optional]" name="pfrontr" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
118 <param label="--p-anywhere-r: TEXT... Sequence of an adapter that may be ligated to the List[Str] 5\' or 3\' end. Both types of matches as described under `adapter` and `front` are allowed. If the first base of the read is part of the match, the behavior is as with `front`, otherwise as with `adapter`. This option is mostly for rescuing failed library preparations - do not use if you know which end your adapter was ligated to. Search in reverse read. [optional]" name="panywherer" optional="False" type="text" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
119 <param exclude_max="False" label="--p-error-rate: PROPORTION Range(0, 1, inclusive_end=True) Maximum allowed error rate. [default: 0.1]" max="1" min="0" name="perrorrate" optional="True" type="float" value="0.1" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
120 <param label="--p-no-indels: Do not allow insertions or deletions of bases when matching adapters. [default: True]" name="pnoindels" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
121 <param label="--p-times: INTEGER Remove multiple occurrences of an adapter if it is Range(1, None) repeated, up to `times` times. [default: 1]" min="1" name="ptimes" optional="True" type="integer" value="1" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
122 <param label="--p-overlap: INTEGER Require at least `overlap` bases of overlap between Range(1, None) read and adapter for an adapter to be found. [default: 3]" min="1" name="poverlap" optional="True" type="integer" value="3" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
123 <param label="--p-match-read-wildcards: --p-match-read-wildcards: / --p-no-match-read-wildcards Interpret IUPAC wildcards (e.g., N) in reads. [default: False]" name="pmatchreadwildcards" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
124 <param label="--p-no-match-adapter-wildcards: Do not interpret IUPAC wildcards (e.g., N) in adapters. [default: True]" name="pnomatchadapterwildcards" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
125 <param label="--p-minimum-length: INTEGER Range(1, None) Discard reads shorter than specified value. Note, the cutadapt default of 0 has been overridden, because that value produces empty sequence records. [default: 1]" min="1" name="pminimumlength" optional="True" type="integer" value="1" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
126 <param label="--p-discard-untrimmed: --p-discard-untrimmed: / --p-no-discard-untrimmed Discard reads in which no adapter was found. [default: False]" name="pdiscarduntrimmed" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
127 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
128
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
129 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
130
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
131 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
132 <data format="qza" label="${tool.name} on ${on_string}: trimmedsequences.qza" name="otrimmedsequences" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
133
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
134 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
135
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
136 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
137 Find and remove adapters in demultiplexed paired-end sequences.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
138 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
139
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
140 Search demultiplexed paired-end sequences for adapters and remove them. The
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
141 parameter descriptions in this method are adapted from the official
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
142 cutadapt docs - please see those docs at https://cutadapt.readthedocs.io
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
143 for complete details.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
144
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
145 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
146 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
147 demultiplexed_sequences : SampleData[PairedEndSequencesWithQuality]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
148 The paired-end sequences to be trimmed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
149 cores : Int % Range(1, None), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
150 Number of CPU cores to use.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
151 adapter_f : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
152 Sequence of an adapter ligated to the 3' end. The adapter and any
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
153 subsequent bases are trimmed. If a `$` is appended, the adapter is only
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
154 found if it is at the end of the read. Search in forward read. If your
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
155 sequence of interest is "framed" by a 5' and a 3' adapter, use this
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
156 parameter to define a "linked" primer - see
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
157 https://cutadapt.readthedocs.io for complete details.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
158 front_f : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
159 Sequence of an adapter ligated to the 5' end. The adapter and any
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
160 preceding bases are trimmed. Partial matches at the 5' end are allowed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
161 If a `^` character is prepended, the adapter is only found if it is at
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
162 the beginning of the read. Search in forward read.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
163 anywhere_f : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
164 Sequence of an adapter that may be ligated to the 5' or 3' end. Both
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
165 types of matches as described under `adapter` and `front` are allowed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
166 If the first base of the read is part of the match, the behavior is as
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
167 with `front`, otherwise as with `adapter`. This option is mostly for
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
168 rescuing failed library preparations - do not use if you know which end
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
169 your adapter was ligated to. Search in forward read.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
170 adapter_r : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
171 Sequence of an adapter ligated to the 3' end. The adapter and any
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
172 subsequent bases are trimmed. If a `$` is appended, the adapter is only
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
173 found if it is at the end of the read. Search in reverse read. If your
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
174 sequence of interest is "framed" by a 5' and a 3' adapter, use this
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
175 parameter to define a "linked" primer - see
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
176 https://cutadapt.readthedocs.io for complete details.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
177 front_r : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
178 Sequence of an adapter ligated to the 5' end. The adapter and any
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
179 preceding bases are trimmed. Partial matches at the 5' end are allowed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
180 If a `^` character is prepended, the adapter is only found if it is at
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
181 the beginning of the read. Search in reverse read.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
182 anywhere_r : List[Str], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
183 Sequence of an adapter that may be ligated to the 5' or 3' end. Both
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
184 types of matches as described under `adapter` and `front` are allowed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
185 If the first base of the read is part of the match, the behavior is as
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
186 with `front`, otherwise as with `adapter`. This option is mostly for
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
187 rescuing failed library preparations - do not use if you know which end
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
188 your adapter was ligated to. Search in reverse read.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
189 error_rate : Float % Range(0, 1, inclusive_end=True), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
190 Maximum allowed error rate.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
191 indels : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
192 Allow insertions or deletions of bases when matching adapters.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
193 times : Int % Range(1, None), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
194 Remove multiple occurrences of an adapter if it is repeated, up to
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
195 `times` times.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
196 overlap : Int % Range(1, None), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
197 Require at least `overlap` bases of overlap between read and adapter
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
198 for an adapter to be found.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
199 match_read_wildcards : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
200 Interpret IUPAC wildcards (e.g., N) in reads.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
201 match_adapter_wildcards : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
202 Interpret IUPAC wildcards (e.g., N) in adapters.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
203 minimum_length : Int % Range(1, None), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
204 Discard reads shorter than specified value. Note, the cutadapt default
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
205 of 0 has been overridden, because that value produces empty sequence
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
206 records.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
207 discard_untrimmed : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
208 Discard reads in which no adapter was found.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
209
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
210 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
211 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
212 trimmed_sequences : SampleData[PairedEndSequencesWithQuality]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
213 The resulting trimmed sequences.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
214 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
215 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
216 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
217 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
218 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
219 </tool>