comparison samtools_idxstats.xml @ 1:88b8c2916784 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40

0:87398ae795c7

<tool id="samtools_idxstats" name="IdxStats" version="2.0">
    <description>tabulate mapping statistics for BAM dataset</description>
    <macros>
      <import>macros.xml</import>
    </macros>
    <expand macro="requirements"></expand>
    <expand macro="stdio"></expand>
    <expand macro="version_command"></expand>
    <command><![CDATA[
if [ ! -f "${input}.bai" ] ; then
    ln -s "${input}" input.bam ;
    samtools sort -o sorted.bam -O bam -T sts "${input}" ;
    samtools index sorted.bam ;
    samtools idxstats sorted.bam > "${output}" ;
else
    samtools idxstats "${input}" > "${output}" ;
fi]]>
    </command>
    <inputs>
        <param name="input" type="data" format="bam" label="BAM file" />
    </inputs>
    <outputs>
        <data format="tabular" name="output" label="${tool.name} on ${on_string}" />

        <test>
            <param name="input" value="phiX.bam" ftype="bam" />
            <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
        </test>
    </tests>
    <help>
<![CDATA[
**What it does**

Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.

Input is a sorted and indexed BAM file, the output is tabular with

 ...           ...    ...   ...
 contig_603    653     50     0
 contig_604    214      6     0
 \*              0      0 50320


In this example there were 604 contigs, each with one line in the output table,
plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
In this BAM file, the final column was otherwise zero.

------

Peter J.A. Cock (2013), `Galaxy wrapper <https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_idxstats>`_ for the samtools idxstats command
]]>
    </help>
    <expand macro="citations"></expand>
</tool>

1:88b8c2916784

<tool id="samtools_idxstats" name="IdxStats" version="2.0.1">
    <description>reports stats of the BAM index file</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="stdio"/>
    <expand macro="version_command"/>
    <command><![CDATA[
        ln -f -s '${input.metadata.bam_index}' '${input}.bai' &&

        samtools idxstats '${input}' > '${output}'
    ]]></command>
    <inputs>
        <param name="input" type="data" format="bam" label="BAM file" />
    </inputs>
    <outputs>
        <data format="tabular" name="output" label="${tool.name} on ${on_string}" />

        <test>
            <param name="input" value="phiX.bam" ftype="bam" />
            <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
        </test>
    </tests>
    <help><![CDATA[
**What it does**

Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.

Input is a sorted and indexed BAM file, the output is tabular with

 ...           ...    ...   ...
 contig_603    653     50     0
 contig_604    214      6     0
 \*              0      0 50320

In this example there were 604 contigs, each with one line in the output table,
plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
In this BAM file, the final column was otherwise zero.

------

Peter J.A. Cock (2013), `Galaxy wrapper <https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_idxstats>`_ for the samtools idxstats command
    ]]></help>
    <expand macro="citations"/>
</tool>