annotate bamtools_split_paired.xml @ 3:75d5afa09972 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tool_collections/bamtools/bamtools_split commit 5ebe920838ab3c36e93d620c479df17f43f8e336

<tool id="bamtools_split_paired" name="Split BAM into paired- and single-end" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
    <description>reads datasets</description>
    <macros>
          <import>macros.xml</import>
    </macros>
    <expand macro="xrefs"/>
    <expand macro="requirements" />
    <command>
        <![CDATA[
            ln -s '${input_bam}' 'localbam.bam' &&
            ln -s '${input_bam.metadata.bam_index}' 'localbam.bam.bai' &&
            bamtools split -paired
            -in localbam.bam
            -stub split_bam
        ]]>
    </command>
    <inputs>
        <param name="input_bam" type="data" format="bam" label="BAM dataset to split by single_end/paired_end"/>
    </inputs>
    <outputs>
        <data format="bam" name="single" label="${input_bam.name} SE reads" from_work_dir="split_bam.SINGLE_END.bam" />
        <data format="bam" name="paired" label="${input_bam.name} PE reads" from_work_dir="split_bam.PAIRED_END.bam" />
    </outputs>
    <tests>
        <test>
            <param name="input_bam" ftype="bam" value="bamtools-input-paired.bam"/>
            <output name="single" file="split_bam.SINGLE_END.bam"  compare="sim_size" delta="200" />
            <output name="paired" file="split_bam.PAIRED_END.bam"  compare="sim_size" delta="200" />
        </test>
    </tests>
    <help>
**What is does**

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).

-----

**How it works**

Splits the input BAM file into 2 output files named containing single_end and paired_end reads, respectively.

-----

.. class:: infomark

**More information**

Additional information about BAMtools can be found at https://github.com/pezmaster31/bamtools/wiki

    </help>
    <citations>
        <citation type="doi">10.1093/bioinformatics/btr174</citation>
    </citations>
</tool>