Mercurial > repos > iuc > bamtools_split_tag

annotate bamtools_split_tag.xml @ 0:c9fbbe6f5fc8 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/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
author iuc
date Sat, 27 Nov 2021 10:02:45 +0000
parents
children e30af4e78cd3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
1 <tool id="bamtools_split_tag" name="Split BAM by Tag" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
2 <description>into dataset list collection</description>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
3 <macros>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
5 </macros>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
6 <expand macro="requirements" />
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
7 <command>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
8 <![CDATA[
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
9 #import re
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
10 #set $name = 'split_bam' + $re.sub('\W','_',$re.sub('\.bam$','',$input_bam.name))
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
11 ln -s '${input_bam}' 'localbam.bam' &&
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
12 ln -s '${input_bam.metadata.bam_index}' 'localbam.bam.bai' &&
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
13 bamtools split -tag $tag_name
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
14 -in 'localbam.bam'
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
15 -stub '$name'
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
16 ]]>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
17 </command>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
18 <inputs>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
19 <param name="input_bam" type="data" format="bam" label="BAM dataset to split by tag value"/>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
20 <param name="tag_name" type="text" value="NM" label="Enter tag name here" help="For example, to split on NM tag enter &quot;NM&quot;"/>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
21 </inputs>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
22 <outputs>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
23 <collection name="output_bams" type="list" label="${input_bam.name} Split List">
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
24 <discover_datasets pattern="split_bam(?P&lt;designation&gt;.+)\.bam" ext="bam" visible="false"/>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
25 </collection>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
26 </outputs>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
27 <tests>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
28 <test>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
29 <param name="input_bam" ftype="bam" value="bamtools-input-tags.bam"/>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
30 <param name="tag_name" value="XG"/>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
31 <output_collection name="output_bams" type="list">
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
32 <element name="bamtools_input_tags.TAG_XG_V" file="bamtools_input_tags.TAG_XG_V.bam" compare="sim_size" delta="500" />
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
33 </output_collection>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
34 </test>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
35
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
36 </tests>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
37 <help>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
38 **What is does**
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
39
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
40 BAMTools split is a utility for splitting BAM files. It is based on BAMtools suite of tools by Derek Barnett (https://github.com/pezmaster31/bamtools).
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
41
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
42 -----
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
43
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
44 .. class:: warningmark
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
45
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
46 **DANGER: Multiple Outputs**
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
47
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
48 As described below, splitting a BAM dataset(s) on tag value can produce very large numbers of outputs. Read below and know what you are doing.
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
49
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
50 -----
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
51
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
52 **How it works**
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
53
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
54 Split alignments by tag name into a dataset list collection.
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
55
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
56 This can generate a huge number of output datasets depending on the number of distinct values of the TAG.
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
57
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
58
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
59 -----
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
60
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
61 .. class:: infomark
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
62
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
63 **More information**
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
64
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
65 Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
66
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
67 </help>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
68 <citations>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
69 <citation type="doi">10.1093/bioinformatics/btr174</citation>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
70 </citations>
c9fbbe6f5fc8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
71 </tool>