annotate clipping_profile.xml @ 33:073c77ce5e94

export PYTHONPATH during install, note python 2.7 requirement

<tool id="rseqc_clipping_profile" name="Clipping Profile" version="1.1">
    <description>
     estimates clipping profile of RNA-seq reads from BAM or SAM file
    </description>
    <requirements>
        <requirement type="package" version="3.0.1">R</requirement>
        <requirement type="package" version="1.7.1">numpy</requirement>
        <requirement type="package" version="2.3.7">rseqc</requirement>
    </requirements>
    <command>
        clipping_profile.py -i $input -o 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" />
    </inputs>
    <outputs>
        <data format="xls" name="outputxls" from_work_dir="output.clipping_profile.xls" />
        <data format="txt" name="outputr" from_work_dir="output.clipping_profile.r" />
    </outputs>
    <help>
clipping_profile.py
+++++++++++++++++++

This program is used to estimate clipping profile of RNA-seq reads from BAM or SAM file.
Note that to use this funciton, CIGAR strings within SAM/BAM file should have 'S' operation
(This means your reads aligner should support clipped mapping).

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

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


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

.. image:: http://rseqc.sourceforge.net/_images/clipping_good.png
   :height: 600 px
   :width: 600 px
   :scale: 80 %

-----

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>