Mercurial > repos > iuc > ivar_removereads

annotate ivar_removereads.xml @ 4:ee2beb764a7b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
author iuc
date Mon, 22 Jun 2020 07:29:10 -0400
parents bd2a7d1316b9
children 75c279fa403a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
1 <tool id="ivar_removereads" name="ivar removereads" version="@VERSION@+galaxy1">
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
2 <description>Remove reads from trimmed BAM file</description>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
3 <macros>
bd2a7d1316b9 "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>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
5 </macros>
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
6 <expand macro="requirements">
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
7 <requirement type="package" version="3.8.1">python</requirement>
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
8 </expand>
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
9 <expand macro="version_command" />
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
11 cp '$input_bed' binding_sites.bed &&
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
12 python '$__tool_directory__/sanitize_bed.py' binding_sites.bed &&
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
13
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
14 ivar getmasked
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
15 -i '$variants_tsv' -b binding_sites.bed -f '$amplicon_info' -p masked_primers &&
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
16
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
17 python '$__tool_directory__/completemask.py' masked_primers.txt '$amplicon_info' &&
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
18 ln -s '$input_bam' sorted.bam &&
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
19 ln -s '${input_bam.metadata.bam_index}' sorted.bam.bai &&
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
20
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
21 ivar removereads
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
22 -i sorted.bam
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
23 -b binding_sites.bed
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
24 -p removed_reads.bam
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
25 -t masked_primers.txt
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
26 ]]></command>
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
27 <inputs>
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
28 <param name="input_bam" argument="-i" type="data" format="bam"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
29 label="Bam input"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
30 help="BAM dataset, preprocessed with ivar trim, to remove reads from" />
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
31 <param name="variants_tsv" type="data" format="tabular"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
32 label="Variants input"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
33 help="This dataset will be scanned for variants that affect primer binding sites and needs to be in tabular format with affected chromosome names in the first, and positions in the second column. If there is a header line, the name of the second column should be POS." />
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
34 <param name="input_bed" argument="-b" type="data" format="bed" label="Primer binding sites information"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
35 help="The same six-column BED dataset that served as input to ivar trim"/>
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
36 <param name="amplicon_info" type="data" format="tabular"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
37 label="Primer to amplicon assignment info"
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
38 help="This input should consist of one line per amplicon with the tab-separated names of all primers used to generate that amplicon."/>
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
39 </inputs>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
40 <outputs>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
41 <data name="output_bam" format="bam" label="${tool.name} on ${on_string}" from_work_dir="removed_reads.bam"/>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
42 </outputs>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
43 <tests>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
44 <test>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
45 <param name="input_bam" value="zika/Z52_a.trimmed.sorted.bam"/>
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
46 <param name="variants_tsv" value="zika/primers_Z52_consensus.tsv"/>
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
47 <param name="input_bed" value="zika/db/zika_primers_consensus.bed"/>
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
48 <param name="amplicon_info" value="zika/db/pair_information.tsv"/>
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
49 <output name="output_bam" file="zika/Z52_a.masked.bam" compare="sim_size" delta="100000" />
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
50 </test>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
51 </tests>
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
52 <help><![CDATA[
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
53 This Galaxy tool combines the functionality of ``ivar getmasked`` and
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
54 ``ivar removereads``. No separate ``ivar getmasked`` step is required when
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
55 using this tool.
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
56
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
57 The wrapper takes as input a BAM dataset of aligned and sorted reads, from
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
58 which the primers listed in the primer binding sites BED input have been
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
59 trimmed with ``ivar trim``.
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
60
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
61 From this input it will remove reads that come from amplicons that have been
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
62 generated with one or more primers that may have been affected in their binding
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
63 by variants listed in the variants input file.
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
64
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
65 .. class:: Warning mark
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
66
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
67 Preprocessing of the BAM input with ivar trim is essential for this tool to
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
68 work because only ``ivar trim`` can add required primer information to the
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
69 BAM auxillary data of every read.
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
70
4
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
71 ivar documentation can be found at `<https://andersen-lab.github.io/ivar/html/manualpage.html>`__.
ee2beb764a7b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 693df287d23b0fd9dfd134b41d401a438c3f5ad6"
iuc
parents: 0
diff changeset
72 ]]></help>
0
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
73 <expand macro="citations" />
bd2a7d1316b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
74 </tool>