annotate qiime_cutadapt_trim-single.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_cutadapt_trim-single" name="qiime cutadapt trim-single" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Find and remove adapters in demultiplexed single-end sequences.</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime cutadapt trim-single --i-demultiplexed-sequences=$idemultiplexedsequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #if '__sq__' in str($panywhere):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #set $panywhere_temp = $panywhere.replace('__sq__', "'")
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #set $panywhere = $panywhere_temp
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #if str($panywhere):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 --p-anywhere="$panywhere"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 #if $poverlap:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 --p-overlap=$poverlap
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 #if str($pfront):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 --p-front="$pfront"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 #if $ptimes:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 --p-times=$ptimes
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 --o-trimmed-sequences=otrimmedsequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 #if $pindels:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 --p-indels
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 #if $perrorrate:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 --p-error-rate=$perrorrate
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 #if $pmatchadapterwildcards:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 --p-match-adapter-wildcards
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 #set $slots = '${GALAXY_SLOTS:-4}'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 --p-cores=$slots
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 #if str($padapter):
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 --p-adapter="$padapter"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 #if $pmatchreadwildcards:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 --p-match-read-wildcards
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 cp otrimmedsequences.qza $otrimmedsequences
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 <param format="qza,no_unzip.zip" label="--i-demultiplexed-sequences: SampleData[SequencesWithQuality] The single-end sequences to be trimmed. [required]" name="idemultiplexedsequences" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-adapter: 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. 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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-front: 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. [optional]" name="pfront" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-anywhere: 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. [optional]" name="panywhere" optional="True" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 <param label="--p-error-rate: Maximum allowed error rate. [default: 0.1]" name="perrorrate" optional="True" type="float" value="0.1"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 <param label="--p-indels: --p-no-indels Allow insertions or deletions of bases when matching adapters. [default: True]" name="pindels" checked="False" type="boolean"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 <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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 <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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80 <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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 <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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 <data format="qza" label="${tool.name} on ${on_string}: trimmed-sequences.qza" name="otrimmedsequences"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 Find and remove adapters in demultiplexed single-end sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90 ----------------------------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
92 Search demultiplexed single-end sequences for adapters and remove them. The
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
93 parameter descriptions in this method are adapted from the official
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
94 cutadapt docs - please see those docs at https://cutadapt.readthedocs.io
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
95 for complete details.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
96
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
97 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
98 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
99 demultiplexed_sequences : SampleData[SequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
100 The single-end sequences to be trimmed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
101 adapter : List[Str], optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
102 Sequence of an adapter ligated to the 3' end. The adapter and any
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
103 subsequent bases are trimmed. If a `$` is appended, the adapter is only
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
104 found if it is at the end of the read. If your sequence of interest is
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
105 "framed" by a 5' and a 3' adapter, use this parameter to define a
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
106 "linked" primer - see https://cutadapt.readthedocs.io for complete
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
107 details.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
108 front : List[Str], optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
109 Sequence of an adapter ligated to the 5' end. The adapter and any
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
110 preceding bases are trimmed. Partial matches at the 5' end are allowed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
111 If a `^` character is prepended, the adapter is only found if it is at
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
112 the beginning of the read.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
113 anywhere : List[Str], optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
114 Sequence of an adapter that may be ligated to the 5' or 3' end. Both
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
115 types of matches as described under `adapter` and `front` are allowed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
116 If the first base of the read is part of the match, the behavior is as
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
117 with `front`, otherwise as with `adapter`. This option is mostly for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
118 rescuing failed library preparations - do not use if you know which end
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
119 your adapter was ligated to.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
120 error_rate : Float % Range(0, 1, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
121 Maximum allowed error rate.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
122 indels : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
123 Allow insertions or deletions of bases when matching adapters.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
124 times : Int % Range(1, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
125 Remove multiple occurrences of an adapter if it is repeated, up to
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
126 `times` times.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
127 overlap : Int % Range(1, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
128 Require at least `overlap` bases of overlap between read and adapter
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
129 for an adapter to be found.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
130 match_read_wildcards : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
131 Interpret IUPAC wildcards (e.g., N) in reads.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
132 match_adapter_wildcards : Bool, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
133 Interpret IUPAC wildcards (e.g., N) in adapters.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
134
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
135 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
136 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
137 trimmed_sequences : SampleData[SequencesWithQuality]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
138 The resulting trimmed sequences.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
139 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
140 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
141 </tool>