Source code

Download source archive ↓

upstream-extended/iuc/tool_collections/samtools/samtools_idxstats/samtools_idxstats.xml

1<tool id="samtools_idxstats" name="Samtools idxstats" version="2.0.8" profile="@PROFILE@">
2    <description>reports stats of the BAM index file</description>
3    <macros>
4        <import>macros.xml</import>
5    </macros>
6    <expand macro="requirements"/>
7    <expand macro="stdio"/>
8    <expand macro="version_command"/>
9    <command><![CDATA[
10@ADDTHREADS@
11@PREPARE_IDX@
12samtools idxstats -@ \$addthreads infile  > '${output}'
13    ]]></command>
14    <inputs>
15        <param name="input" type="data" format="bam,cram" label="BAM file" />
16    </inputs>
17    <outputs>
18        <data format="tabular" name="output" label="${tool.name} on ${on_string}" />
19    </outputs>
20    <tests>
21        <!-- test from https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2556 -->
22        <test>
23            <param name="input" value="test_input_1_a.bam" ftype="bam" />
24            <output name="output" file="test_input_1_a.bam.expected" compare="diff" ftype="tabular" />
25        </test>
26        <!-- test from original tool -->
27	<test>
28            <param name="input" value="phiX.bam" ftype="bam" />
29            <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
30        </test>
31    </tests>
32    <help><![CDATA[
33**What it does**
34
35Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.
36
37Input is a sorted and indexed BAM file, the output is tabular with
38four columns (one row per reference sequence plus a final line for
39unmapped reads)::
40
41 Column Description
42 ------ -----------------------------
43      1 Reference sequence identifier
44      2 Reference sequence length
45      3 Number of mapped reads
46      4 Number of placed but unmapped reads
47           (typically unmapped partners of mapped reads)
48
49------
50
51**Example** output from a *de novo* assembly::
52
53 contig_1   170035  98397     0
54 contig_2   403835 199564     0
55 contig_3   553102 288189     0
56 ...           ...    ...   ...
57 contig_603    653     50     0
58 contig_604    214      6     0
59 \*              0      0 50320
60
61In this example there were 604 contigs, each with one line in the output table,
62plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
63In this BAM file, the final column was otherwise zero.
64
65
66The results of samtools ixdstats can be visualized with MultiQC.
67
68------
69
70Peter J.A. Cock (2013), `Galaxy wrapper <https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_idxstats>`_ for the samtools idxstats command
71    ]]></help>
72    <expand macro="citations"/>
73</tool>