annotate bamtools_split_mapped.xml @ 3:fa7b5520ae53 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 5ebe920838ab3c36e93d620c479df17f43f8e336
author iuc
date Fri, 15 Mar 2024 13:49:55 +0000
parents 6dbef7ea2253
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
6dbef7ea2253 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 862f05b5053f55def8007194a702019418697cb5
iuc
parents: 0
diff changeset
1 <tool id="bamtools_split_mapped" name="Split BAM by reads mapping status" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
6dbef7ea2253 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 862f05b5053f55def8007194a702019418697cb5
iuc
parents: 0
diff changeset
2 <description>into a mapped and an unmapped dataset</description>
0
2ed961caae0a "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>
2ed961caae0a "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>
2ed961caae0a "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>
3
fa7b5520ae53 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 5ebe920838ab3c36e93d620c479df17f43f8e336
iuc
parents: 2
diff changeset
6 <expand macro="xrefs"/>
0
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
7 <expand macro="requirements" />
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
8 <command>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
9 <![CDATA[
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
10 ln -s '${input_bam}' 'localbam.bam' &&
2ed961caae0a "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.metadata.bam_index}' 'localbam.bam.bai' &&
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
12 bamtools split -mapped
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
13 -in localbam.bam
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
14 -stub split_bam
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
15 ]]>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
16 </command>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
17 <inputs>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
18 <param name="input_bam" type="data" format="bam" label="BAM dataset to split by mapped/unmapped"/>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
19 </inputs>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
20 <outputs>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
21 <data format="bam" name="mapped" label="${input_bam.name} mapped" from_work_dir="split_bam.MAPPED.bam" />
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
22 <data format="bam" name="unmapped" label="${input_bam.name} unmapped" from_work_dir="split_bam.UNMAPPED.bam" />
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
23 </outputs>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
24 <tests>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
25 <test>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
26 <param name="input_bam" ftype="bam" value="bamtools-input1.bam"/>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
27 <output name="mapped" file="split_bam.MAPPED.bam" compare="sim_size" delta="200" />
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
28 <output name="unmapped" file="split_bam.UNMAPPED.bam" compare="sim_size" delta="200" />
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
29 </test>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
30 </tests>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
31 <help>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
32 **What is does**
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
33
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
34 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).
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
35
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
36 -----
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
37
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
38 **How it works**
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
39
2
6dbef7ea2253 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 862f05b5053f55def8007194a702019418697cb5
iuc
parents: 0
diff changeset
40 Splits the input BAM file into 2 output files containing mapped and unmapped reads, respectively.
0
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
41
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
42 -----
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
43
2ed961caae0a "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:: infomark
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
45
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
46 **More information**
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
47
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
48 Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
49
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
50 </help>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
51 <citations>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
52 <citation type="doi">10.1093/bioinformatics/btr174</citation>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
53 </citations>
2ed961caae0a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
54 </tool>