annotate qiime2/qiime_cutadapt_trim-single.xml @ 29:3ba9833030c1 draft

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