view RPKM_count.xml @ 32:580ee0c4bc4e

Fixes from Bjorn Gruning: create symlinks under $TMP and clean them up afterwards, replace R dependency with the Tool Shed R3 package, add --install-scripts, prepend tool-ids with rseqc

<tool id="rseqc_RPKM_count" name="RPKM Count" version="1.1">
    <description>calculates raw count and RPKM values for transcript at exon, intron, and mRNA level</description>
    <requirements>
        <requirement type="package" version="1.7.1">numpy</requirement>
        <requirement type="package" version="2.3.7">rseqc</requirement>
    </requirements>
    <command>
        ln -s "${input}" "local_input.bam" &amp;&amp;
        ln -s "${input.metadata.bam_index}" "local_input.bam.bai" &amp;&amp;
        RPKM_count.py -i "local_input.bam" -o output -r $refgene

        #if str($strand_type.strand_specific) == "pair"
            -d
            #if str($strand_type.pair_type) == "sd"
                '1++,1--,2+-,2-+'
            #else
                '1+-,1-+,2++,2--'
            #end if
        #end if

        #if str($strand_type.strand_specific) == "single"
            -d
            #if str($strand_type.single_type) == "s"
                '++,--'
            #else
                '+-,-+'
            #end if
        #end if

        #if $skiphits
            -u
        #end if

        #if $onlyexonic
            -e
        #end if

    </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" format="bam" label="input bam/sam file" />
        <param name="refgene" type="data" format="bed" label="Reference gene model" />
        <conditional name="strand_type">
            <param name="strand_specific" type="select" label="Strand-specific?" value="None">
                <option value="none">None</option>
                <option value="pair">Pair-End RNA-seq</option>
                <option value="single">Single-End RNA-seq</option>
            </param>
            <when value="pair">
                <param name="pair_type" type="select" display="radio" label="Pair-End Read Type (format: mapped --> parent)" value="sd">
                    <option value="sd"> read1 (positive --> positive; negative --> negative), read2 (positive --> negative; negative --> positive)</option>
                    <option value="ds">read1 (positive --> negative; negative --> positive), read2 (positive --> positive; negative --> negative)</option>
                </param>
            </when>
            <when value="single">
                <param name="single_type" type="select" display="radio" label="Single-End Read Type (format: mapped --> parent)" value="s">
                    <option value="s">positive --> positive; negative --> negative</option>
                    <option value="d">positive --> negative; negative --> positive</option>
                </param>
            </when>
            <when value="none"></when>
        </conditional>
        <param name="skiphits" type="boolean" value="false" label="Skip Multiple Hit Reads" />
        <param name="onlyexonic" type="boolean" value="false" label="Only use exonic (UTR exons and CDS exons) reads, otherwise use all reads" />
    </inputs>
    <outputs>
        <data format="xls" name="outputxls" from_work_dir="output_read_count.xls"/>
    </outputs>
    <help>
RPKM_count.py
+++++++++++++

Given a BAM file and reference gene model, this program will calculate the raw count and RPKM
values for transcript at exon, intron and mRNA level. For strand specific RNA-seq data,
program will assign read to its parental gene according to strand rule, if you don't know the
strand rule, run infer_experiment.py. Please note that chromosome ID, genome cooridinates
should be concordant between BAM and BED files. 

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

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

Reference gene model
    Gene model in BED format.

Strand sequencing type (default=none)
    See Infer Experiment tool if uncertain.

Options
++++++++++++++

Skip Multiple Hit Reads
    Use Multiple hit reads or use only uniquely mapped reads.

Only use exonic reads 
    Renders program only used exonic (UTR exons and CDS exons) reads, otherwise use all reads.

Sample Output
++++++++++++++

=====   ========   ========   =====================    =====  ===========   =============   =============   ========  =========
chrom   start      end        accession                score  gene strand   tag count (+)   tag count (-)   RPKM (+)  RPKM (-)
=====   ========   ========   =====================    =====  ===========   =============   =============   ========  =========
chr1    29213722   29313959   NM_001166007_intron_1    0      '+'             431             4329            0.086     0.863
chr1    29314417   29319841   NM_001166007_intron_2    0      '+'             31              1               0.114     0.004
chr1    29320054   29323726   NM_001166007_intron_3    0      '+'             32              0               0.174     0.000
chr1    29213602   29213722   NM_001166007_exon_1      0      '+'             164             0               27.321    0.000
chr1    29313959   29314417   NM_001166007_exon_2      0      '+'            1699            4               74.158    0.175
chr1    29319841   29320054   NM_001166007_exon_3      0      '+'             528             1               49.554    0.094
=====   ========   ========   =====================    =====  ===========   =============   =============   ========  =========
    
-----

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/


    </help>
</tool>