annotate qiime2/qiime_cutadapt_trim-single.xml @ 0:370e0b6e9826 draft

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