annotate ivar_trim.xml @ 22:6606a8c97889 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
author iuc
date Wed, 06 Aug 2025 08:21:20 +0000
parents c9ef01b1cfba
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
1 <tool id="ivar_trim" name="ivar trim" version="@TOOL_VERSION@+galaxy1" profile="@PROFILE@">
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
2 <description>Trim reads in aligned BAM</description>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
3 <macros>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
5 </macros>
20
c9ef01b1cfba planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit b548a504e88bd330f534be0dd018175c9341b1f1
iuc
parents: 16
diff changeset
6 <expand macro="xrefs"/>
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
7 <expand macro="requirements">
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
8 <requirement type="package" version="0.1.0">viramp-hub</requirement>
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
9 </expand>
12
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
10 <expand macro="version_command"/>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
12 ## Prepare primer scheme and, if necessary, also amplicon info file
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
13 #if $primer.source == 'history'
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
14 ln -s '$primer.input_bed' bed.bed &&
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
15 #else
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
16 ln -s '$primer.cached_bed.fields.path' bed.bed &&
4
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
17 #end if
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
18 scheme-convert --to bed --bed-type ivar -o ivar.bed bed.bed &&
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
19 #if $amplicons.filter_by == 'yes_compute':
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
20 scheme-convert --to amplicon-info -r outer -o amplicon_info.tsv ivar.bed &&
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
21 #elif $amplicons.filter_by == 'yes':
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
22 ## just check the amplicon info file against the primer scheme and reduce it to its outer primers
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
23 scheme-convert -a '$amplicons.amplicon_info' --to amplicon-info -r outer -o amplicon_info.tsv ivar.bed &&
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
24 #end if
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
25 ln -s '$input_bam' sorted.bam &&
4
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
26 ln -s '${input_bam.metadata.bam_index}' sorted.bam.bai &&
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
27
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
28 ivar trim
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
29 -i sorted.bam
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
30 -b ivar.bed
13
f0cc9cf99407 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a16957b7f6cb8687daafb005c0036abebce59b26
iuc
parents: 12
diff changeset
31 #if $amplicons.filter_by == 'yes' or $amplicons.filter_by == 'yes_compute'
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
32 -f amplicon_info.tsv
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
33 #end if
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
34 -x $primer_pos_wiggle
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
35 $inc_primers
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
36 #if $trimmed_length.filter == 'off':
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
37 -m 0
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
38 #elif $trimmed_length.filter == 'auto':
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
39 -m -1
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
40 #else:
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
41 -m $trimmed_length.min_len
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
42 #end if
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
43 -q $min_qual
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
44 -s $window_width
16
28e4bcbc86e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 51d656555f9635bb8988f9eec904ee66657736e1
iuc
parents: 15
diff changeset
45 | samtools sort -@ \${GALAXY_SLOTS:-1} -T "\${TMPDIR:-.}" -o trimmed.sorted.bam -
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
46 ]]></command>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
47 <inputs>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
48 <param name="input_bam" argument="-i" type="data" format="bam" label="Bam file" help="Aligned reads, to trim primers and quality"/>
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
49 <conditional name="primer">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
50 <param label="Source of primer information" name="source" type="select">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
51 <option value="history" selected="true">History</option>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
52 <option value="cached">Built-in</option>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
53 </param>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
54 <when value="history">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
55 <param name="input_bed" argument="-b" type="data" format="bed" label="BED file with primer sequences and positions"/>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
56 </when>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
57 <when value="cached">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
58 <param name="cached_bed" type="select" label="Primer scheme name" help="Select primer scheme bed file from a list">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
59 <options from_data_table="primer_scheme_bedfiles">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
60 <filter type="sort_by" column="1" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
61 <validator type="no_options" message="No primer schemes are available" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
62 </options>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
63 </param>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
64 </when>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
65 </conditional>
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
66 <conditional name="amplicons">
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
67 <param name="filter_by" type="select"
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
68 label="Filter reads based on amplicon info"
9
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
69 help="When you select Yes, reads that are not fully contained in any amplicon will be dropped before primer trimming. This option is currently marked as [Experimental] in ivar, but nevertheless recommended here. Info on amplicons can be computed from suitable primer BED files (see tool help below) or provided by the user. ">
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
70 <option value="">No, allow reads to extend beyond amplicon boundaries</option>
8
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
71 <option value="yes_compute">Yes, drop reads that extend beyond amplicon boundaries</option>
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
72 <option value="yes">Yes, drop reads that extend beyond amplicon boundaries and use my amplicon info file</option>
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
73 </param>
8
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
74 <when value="yes_compute" />
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
75 <when value="yes">
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
76 <param name="amplicon_info" argument="-f" type="data" format="tabular" />
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
77 </when>
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
78 <when value="" />
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
79 </conditional>
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
80 <param name="primer_pos_wiggle" argument="-x" type="integer" min="0" value="0"
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
81 label="Wiggling room for read ends relative to primer binding sites"
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
82 help="Reads that occur at the specified offset positions relative to primer positions (as annotated in the primer information dataset) will also be trimmed (default: 0)" />
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
83 <param name="inc_primers" argument="-e" type="boolean" truevalue="-e" falsevalue="" checked="false" label="Include reads not ending in any primer binding sites?"/>
13
f0cc9cf99407 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a16957b7f6cb8687daafb005c0036abebce59b26
iuc
parents: 12
diff changeset
84 <param name="min_qual" argument="-q" type="integer" min="0" max="255" value="20" label="Minimum quality threshold for sliding window to pass"/>
f0cc9cf99407 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a16957b7f6cb8687daafb005c0036abebce59b26
iuc
parents: 12
diff changeset
85 <param name="window_width" argument="-s" type="integer" min="0" max="255" value="4" label="Width of sliding window"/>
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
86 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
87 <param name="filter" type="select" label="Require a minimum length for reads to retain them after any trimming?" help="The default automatic setting will determine the threshold as 50% of the mean length of the first 1000 raw input reads, which may or may not be adequate for your data. You can always make the outcome of filtering more predictable by specifying the threshold explicitly. You can also opt to retain reads independently of their trimmed length, but typically this only makes sense if you are performing additional read filtering with additional tools in your analysis pipeline.">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
88 <option value="off">No, keep reads independently of their trimmed length (-m 0)</option>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
89 <option value="auto" selected="true">Yes, and determine required length threshold automatically from input (-m -1)</option>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
90 <option value="custom">Yes, and provide a custom threshold</option>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
91 </param>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
92 <when value="off" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
93 <when value="auto" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
94 <when value="custom">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
95 <param name="min_len" argument="-m" type="integer" min="1" value="30" label="Minimum trimmed length threshold" help="Reads with a trimmed length shorter than this value will be discarded."/>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
96 </when>
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
97 </conditional>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
98 </inputs>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
99 <outputs>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
100 <data name="output_bam" format="bam" label="${tool.name} on ${on_string} Trimmed bam" from_work_dir="trimmed.sorted.bam"/>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
101 </outputs>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
102 <tests>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
103 <!-- #1: SARS-Cov data-->
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
104 <test>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
105 <param name="input_bam" value="covid19/PC00101P_sub.sorted.bam" />
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
106 <param name="input_bed" value="covid19/ARTIC-V1.bed" />
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
107 <param name="inc_primers" value="true" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
108 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
109 <param name="filter" value="custom" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
110 <param name="min_len" value="30" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
111 </conditional>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
112 <output name="output_bam" file="covid19/PC00101P_sub.sorted.bam" compare="sim_size" delta="300000"/>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
113 </test>
4
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
114 <test>
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
115 <!-- Test with primer bed file that needs to be sanitized -->
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
116 <param name="input_bam" value="covid19/PC00101P_sub.sorted.bam" />
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
117 <param name="input_bed" ftype="bed" value="covid19/ARTIC-V1-bad.bed" />
4
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
118 <param name="inc_primers" value="true" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
119 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
120 <param name="filter" value="custom" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
121 <param name="min_len" value="30" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
122 </conditional>
4
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
123 <output name="output_bam" file="covid19/PC00101P_sub.sorted.bam" compare="sim_size" delta="300000"/>
db536ad45f28 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 3
diff changeset
124 </test>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
125 <!-- #1: Zika data-->
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
126 <test>
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
127 <conditional name="primer">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
128 <param name="source" value="history" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
129 <param name="input_bed" value="zika/db/zika_primers.bed" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
130 </conditional>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
131 <param name="input_bam" value="zika/Z52_a.sorted.bam" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
132 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
133 <param name="filter" value="custom" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
134 <param name="min_len" value="30" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
135 </conditional>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
136 <output name="output_bam" file="zika/Z52_a.trimmed.sorted.bam" compare="sim_size" delta="100000"/>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
137 </test>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
138 <test>
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
139 <conditional name="primer">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
140 <param name="source" value="history" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
141 <param name="input_bed" value="zika/db/zika_primers.bed" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
142 </conditional>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
143 <param name="input_bam" value="zika/Z52_b.sorted.bam" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
144 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
145 <param name="filter" value="auto" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
146 </conditional>
12
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
147 <output name="output_bam" ftype="bam">
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
148 <assert_contents>
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
149 <has_size value="3373924" delta="1000"/>
12
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
150 </assert_contents>
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
151 </output>
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
152 <assert_stderr>
12
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
153 <has_text text="Found 68 primers in BED file"/>
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
154 <has_text text="reads were quality trimmed below the minimum length of 125 bp and were not written to file"/>
12
e3bb03cf207a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 11
diff changeset
155 <has_text text="reads that started outside of primer regions were not written to file"/>
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
156 </assert_stderr>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
157 </test>
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
158 <test>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
159 <conditional name="primer">
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
160 <param name="source" value="cached" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
161 <param name="cached_bed" value="SARS-CoV-2-ARTICv1" />
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
162 </conditional>
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
163 <param name="input_bam" value="sars-cov-2/sars_cov2_untrimmed.bam" ftype="bam" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
164 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
165 <param name="filter" value="custom" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
166 <param name="min_len" value="30" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
167 </conditional>
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
168 <output name="output_bam" file="sars-cov-2/sars_cov2_trimmed.bam" compare="sim_size" delta="100000"/>
2
cb903c9dc33d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 2d91c217cf30938da84dea51aa3c45a7789db0fc"
iuc
parents: 0
diff changeset
169 </test>
8
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
170 <test>
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
171 <conditional name="primer">
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
172 <param name="source" value="cached" />
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
173 <param name="cached_bed" value="SARS-CoV-2-ARTICv1" />
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
174 </conditional>
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
175 <conditional name="amplicons">
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
176 <param name="filter_by" value="yes_compute" />
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
177 </conditional>
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
178 <param name="input_bam" value="sars-cov-2/sars_cov2_untrimmed.bam" ftype="bam" />
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
179 <conditional name="trimmed_length">
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
180 <param name="filter" value="custom" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
181 <param name="min_len" value="30" />
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
182 </conditional>
10
9f978da6528a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 27f076c829f3b79c170cad55fc19e2f48c8b22ed"
iuc
parents: 9
diff changeset
183 <assert_command>
22
6606a8c97889 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 97f230215d53e71748c78cd21633d92143710b94
iuc
parents: 20
diff changeset
184 <has_text text="scheme-convert --to amplicon-info -r outer" />
10
9f978da6528a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 27f076c829f3b79c170cad55fc19e2f48c8b22ed"
iuc
parents: 9
diff changeset
185 </assert_command>
8
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
186 <output name="output_bam" file="sars-cov-2/sars_cov2_trimmed.bam" compare="sim_size" delta="100000"/>
397e5f0eb3ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 6dae6f97a45a61b1f10be4227d978584624c3b3d"
iuc
parents: 5
diff changeset
187 </test>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
188 </tests>
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
189 <help><![CDATA[
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
190 iVar uses primer positions supplied in a BED file to soft clip primer
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
191 sequences from an aligned and sorted BAM file. Following this, the reads are
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
192 trimmed further based on a quality threshold.
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
193
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
194 **Primer and Amplicon info**
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
195
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
196 The tool requires information about primers and their binding sites in 6-column
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
197 BED format. The information from this file is used to decide whether any mapped
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
198 read in the BAM input ends with a primer sequence and should, thus, be
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
199 soft-clipped.
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
200
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
201 Optionally, the tool can also discard reads that do not fully map to within any
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
202 amplicon. Such reads are likely to be wet-lab or mapping artefacts and removing
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
203 them can increase variant calling precision. To calculate the extent of
9
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
204 expected amplicons the tool needs to know which primers work together to form
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
205 an amplicon. The tool can try to deduce this info from the names of the primers
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
206 found in the primer info dataset. This will require a primer naming scheme
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
207 following the regex pattern::
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
208
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
209 .*_(?P<amplicon_number>\d+).*_(?P<primer_orientation>L(?:EFT)?|R(?:IGHT)?)
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
210
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
211 *i.e.*, the following schemes will work (and get parsed as):
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
212
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
213 - ``nCoV-2019_1_LEFT`` (forward primer of amplicon 1)
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
214
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
215 - ``400_2_out_R`` (reverse primer of amplicon 2)
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
216
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
217 - ``QIAseq_163-2_LEFT`` (forward primer of amplicon 163)
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
218
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
219 Alternatively, you can specify the amplicon information explicitly through a
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
220 dataset that lists the names of primers that together form any given amplicon.
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
221 In it, primer names (exactly matching those in the primer info dataset) need to
c092052ed673 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit f09d0bee3e957564beccb1bdb3610de02f639ec7"
iuc
parents: 8
diff changeset
222 be TAB-separated with one line per amplicon.
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
223 If the primer scheme has more than two primers contributing to a given amplicon
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
224 (in schemes using alternate primers), you can (in this Galaxy tool only)
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
225 specify all of them on one line and the tool will calculate the maximum extent
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
226 of the amplicon.
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
227
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
228 **Quality trimming details and final length filtering**
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
229
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
230 To do the quality trimming, iVar uses a sliding window approach. The window
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
231 slides from the 5' end to the 3' end and if at any point the average base
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
232 quality in the window falls below the threshold, the remaining read is soft
15
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
233 clipped.
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
234
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
235 Finally, the trimmed length threshold gets applied if specified, and fully
a2b94388d00d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 14
diff changeset
236 trimmed surviving reads are written to the BAM output.
5
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
237
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
238 Documentation can be found at `<https://andersen-lab.github.io/ivar/html/manualpage.html>`_.
cf65217ad61c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a5ff06c631a2a5a0d5d44edd6cb58a599d50918b"
iuc
parents: 4
diff changeset
239 ]]></help>
0
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
240 <expand macro="citations" />
8858fa037a15 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
241 </tool>