annotate bam_stat.xml @ 46:68ada7ca4cc4 draft

Fixed geneBody coverage sample names

<tool id="rseqc_bam_stat" name="BAM/SAM Mapping Stats" version="2.4">
    <description>
        reads mapping statistics for a provided BAM or SAM file.
    </description>
    <requirements>
        <requirement type="package" version="1.7.1">numpy</requirement>
        <requirement type="package" version="2.4">rseqc</requirement>
    </requirements>s
    <command>
        bam_stat.py -i $input -q $mapqual 2> $output
    </command>
    <stdio>
        <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
        <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
    </stdio>
    <inputs>
        <param name="input" type="data" label="Input .bam/.sam File" format="bam,sam" />
        <param label="Minimum mapping quality (default=30" type="integer" value="30" name="mapqual" />
    </inputs>
    <outputs>
        <data format="txt" name="output" />
    </outputs>
    <help>
bam_stat.py
+++++++++++

This program is used to calculate reads mapping statistics from provided BAM
file.  This script determines "uniquely mapped reads" from `mapping quality`_,
which quality the probability that a read is misplaced (Do NOT confused with
sequence quality, sequence quality measures the probability that a base-calling
was wrong) .

Inputs
++++++++++++++

Input BAM/SAM file
	Alignment file in BAM/SAM format.

Minimum mapping quality
	Minimum mapping quality for an alignment to be called “uniquely mapped” (default=30)

Output
++++++++++++++

- Total Reads (Total records) = {Multiple mapped reads} + {Uniquely mapped}
- Uniquely mapped Reads = {read-1} + {read-2} (if paired end)
- Uniquely mapped Reads = {Reads map to '+'} + {Reads map to '-'}
- Uniquely mapped Reads = {Splice reads} + {Non-splice reads}

-----

About RSeQC 
+++++++++++

The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.

The RSeQC package is licensed under the GNU GPL v3 license.

.. image:: http://rseqc.sourceforge.net/_static/logo.png

.. _RSeQC: http://rseqc.sourceforge.net/
.. _`mapping quality`: http://genome.sph.umich.edu/wiki/Mapping_Quality_Scores

    </help>
</tool>