annotate bamtools_split_paired.xml @ 4:c5f04783750e draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 7d29261847d2514a1ac4246e0b8bff1d32463434
author iuc
date Wed, 11 Feb 2026 14:31:51 +0000
parents 75d5afa09972
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
c5f04783750e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 7d29261847d2514a1ac4246e0b8bff1d32463434
iuc
parents: 3
diff changeset
1 <tool id="bamtools_split_paired" name="Split BAM into paired- and single-end" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2
5325e44297b9 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>reads datasets</description>
0
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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
75d5afa09972 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
75104ddce35f "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" />
75104ddce35f "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>
75104ddce35f "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[
75104ddce35f "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' &&
75104ddce35f "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' &&
75104ddce35f "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 -paired
75104ddce35f "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
75104ddce35f "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
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
15 ]]>
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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 single_end/paired_end"/>
75104ddce35f "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>
75104ddce35f "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>
4
c5f04783750e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 7d29261847d2514a1ac4246e0b8bff1d32463434
iuc
parents: 3
diff changeset
21 <data format="bam" name="single" label="${tool.name} on ${on_string}: SE reads" from_work_dir="split_bam.SINGLE_END.bam" />
c5f04783750e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 7d29261847d2514a1ac4246e0b8bff1d32463434
iuc
parents: 3
diff changeset
22 <data format="bam" name="paired" label="${tool.name} on ${on_string}: PE reads" from_work_dir="split_bam.PAIRED_END.bam" />
0
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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-input-paired.bam"/>
75104ddce35f "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="single" file="split_bam.SINGLE_END.bam" compare="sim_size" delta="200" />
75104ddce35f "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="paired" file="split_bam.PAIRED_END.bam" compare="sim_size" delta="200" />
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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**
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
33
75104ddce35f "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).
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
35
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
36 -----
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
37
75104ddce35f "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**
75104ddce35f "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
5325e44297b9 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 named containing single_end and paired_end reads, respectively.
0
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
41
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
42 -----
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
43
75104ddce35f "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
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
45
75104ddce35f "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**
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
47
75104ddce35f "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
75104ddce35f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/bamtools/bamtools_split commit 1cacd14cfb2429fefa91fdd05c82d2e36d23283a"
iuc
parents:
diff changeset
49
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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>
75104ddce35f "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>