annotate qiime2/qiime_cutadapt_trim-paired.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_cutadapt_trim-paired" name="qiime cutadapt trim-paired" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Find and remove adapters in demultiplexed paired-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
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9 qiime cutadapt trim-paired --i-demultiplexed-sequences=$idemultiplexedsequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
10
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
11 #if str($padapterf):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
12 --p-adapter-f="$padapterf"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
14
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15 --o-trimmed-sequences=otrimmedsequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
18 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 #if '__sq__' in str($panywheref):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 #set $panywheref_temp = $panywheref.replace('__sq__', "'")
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 #set $panywheref = $panywheref_temp
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 #if str($panywheref):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 --p-anywhere-f="$panywheref"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 #if $poverlap:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 --p-overlap=$poverlap
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34 #if '__sq__' in str($panywherer):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 #set $panywherer_temp = $panywherer.replace('__sq__', "'")
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 #set $panywherer = $panywherer_temp
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 #if str($panywherer):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 --p-anywhere-r="$panywherer"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43 #if $ptimes:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 --p-times=$ptimes
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 #if $pindels:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 --p-indels
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 #if str($padapterr):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 --p-adapter-r="$padapterr"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 #if $perrorrate:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 --p-error-rate=$perrorrate
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 #if $pmatchadapterwildcards:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 --p-match-adapter-wildcards
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 #set $slots = '${GALAXY_SLOTS:-4}'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 --p-cores=$slots
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66 #if str($pfrontr):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 --p-front-r="$pfrontr"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 #if str($pfrontf):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 --p-front-f="$pfrontf"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 #if $pmatchreadwildcards:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 --p-match-read-wildcards
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 cp otrimmedsequences.qza $otrimmedsequences
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 ]]></command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 <param format="qza,no_unzip.zip" label="--i-demultiplexed-sequences: SampleData[PairedEndSequencesWithQuality] The paired-end sequences to be trimmed. [required]" name="idemultiplexedsequences" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 <param label="--p-adapter-f: Sequence of an adapter ligated to the 3' end. The 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 <param label="--p-front-f: Sequence of an adapter ligated to the 5' end. The 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87 <param label="--p-anywhere-f: Sequence of an adapter that may be ligated to the 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 <param label="--p-adapter-r: Sequence of an adapter ligated to the 3' end. The 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90 <param label="--p-front-r: Sequence of an adapter ligated to the 5' end. The 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 <param label="--p-anywhere-r: Sequence of an adapter that may be ligated to the 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="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 <param label="--p-error-rate: Maximum allowed error rate. [default: 0.1]" name="perrorrate" optional="True" type="float" value="0.1"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
95 <param label="--p-indels: --p-no-indels Allow insertions or deletions of bases when matching adapters. [default: True]" name="pindels" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97 <param label="--p-times: Remove multiple occurrences of an adapter if it is repeated, up to `times` times. [default: 1]" name="ptimes" optional="True" type="integer" value="1"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99 <param label="--p-overlap: Require at least `overlap` bases of overlap between read and adapter for an adapter to be found. [default: 3]" name="poverlap" optional="True" type="integer" value="3"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101 <param label="--p-match-read-wildcards: --p-no-match-read-wildcards Interpret IUPAC wildcards (e.g., N) in reads. [default: False]" name="pmatchreadwildcards" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 <param label="--p-match-adapter-wildcards: --p-no-match-adapter-wildcards Interpret IUPAC wildcards (e.g., N) in adapters. [default: True]" name="pmatchadapterwildcards" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 <data format="qza" label="${tool.name} on ${on_string}: trimmed-sequences.qza" name="otrimmedsequences"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 <help><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111 Find and remove adapters in demultiplexed paired-end sequences.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 ----------------------------------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 Search demultiplexed paired-end sequences for adapters and remove them. The
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115 parameter descriptions in this method are adapted from the official
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 cutadapt docs - please see those docs at https://cutadapt.readthedocs.io
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 for complete details.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 demultiplexed_sequences : SampleData[PairedEndSequencesWithQuality]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 The paired-end sequences to be trimmed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 adapter_f : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 Sequence of an adapter ligated to the 3' end. The adapter and any
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
125 subsequent bases are trimmed. If a `$` is appended, the adapter is only
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
126 found if it is at the end of the read. Search in forward read. If your
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
127 sequence of interest is "framed" by a 5' and a 3' adapter, use this
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
128 parameter to define a "linked" primer - see
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
129 https://cutadapt.readthedocs.io for complete details.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
130 front_f : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
131 Sequence of an adapter ligated to the 5' end. The adapter and any
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
132 preceding bases are trimmed. Partial matches at the 5' end are allowed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
133 If a `^` character is prepended, the adapter is only found if it is at
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
134 the beginning of the read. Search in forward read.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
135 anywhere_f : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
136 Sequence of an adapter that may be ligated to the 5' or 3' end. Both
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
137 types of matches as described under `adapter` and `front` are allowed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
138 If the first base of the read is part of the match, the behavior is as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
139 with `front`, otherwise as with `adapter`. This option is mostly for
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
140 rescuing failed library preparations - do not use if you know which end
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
141 your adapter was ligated to. Search in forward read.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
142 adapter_r : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
143 Sequence of an adapter ligated to the 3' end. The adapter and any
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
144 subsequent bases are trimmed. If a `$` is appended, the adapter is only
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
145 found if it is at the end of the read. Search in reverse read. If your
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
146 sequence of interest is "framed" by a 5' and a 3' adapter, use this
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
147 parameter to define a "linked" primer - see
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
148 https://cutadapt.readthedocs.io for complete details.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
149 front_r : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
150 Sequence of an adapter ligated to the 5' end. The adapter and any
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
151 preceding bases are trimmed. Partial matches at the 5' end are allowed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
152 If a `^` character is prepended, the adapter is only found if it is at
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
153 the beginning of the read. Search in reverse read.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
154 anywhere_r : List[Str], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
155 Sequence of an adapter that may be ligated to the 5' or 3' end. Both
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
156 types of matches as described under `adapter` and `front` are allowed.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
157 If the first base of the read is part of the match, the behavior is as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
158 with `front`, otherwise as with `adapter`. This option is mostly for
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
159 rescuing failed library preparations - do not use if you know which end
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
160 your adapter was ligated to. Search in reverse read.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
161 error_rate : Float % Range(0, 1, inclusive_end=True), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
162 Maximum allowed error rate.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
163 indels : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
164 Allow insertions or deletions of bases when matching adapters.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
165 times : Int % Range(1, None), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
166 Remove multiple occurrences of an adapter if it is repeated, up to
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
167 `times` times.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
168 overlap : Int % Range(1, None), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
169 Require at least `overlap` bases of overlap between read and adapter
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
170 for an adapter to be found.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
171 match_read_wildcards : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
172 Interpret IUPAC wildcards (e.g., N) in reads.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
173 match_adapter_wildcards : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
174 Interpret IUPAC wildcards (e.g., N) in adapters.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
175
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
176 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
177 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
178 trimmed_sequences : SampleData[PairedEndSequencesWithQuality]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
179 The resulting trimmed sequences.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
180 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
181 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
182 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
183 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
184 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
185 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
186 </tool>