annotate read_GC.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_read_GC" name="Read GC" version="1.1">
    <description>determines GC% and read count</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>
        read_GC.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" format="bam,sam" label="input bam/sam file" />
    </inputs>
    <outputs>
        <data format="xls" name="outputxls" from_work_dir="output.GC.xls" label="${tool.name} on ${on_string} (XLS)"/>
        <data format="txt" name="outputr" from_work_dir="output.GC_plot.r" label="${tool.name} on ${on_string} (R Script)" />
        <data format="pdf" name="outputpdf" from_work_dir="output.GC_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
    </outputs>
    <help>
read_GC.py
++++++++++


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

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

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

1. output.GC.xls: Two column, plain text file, first column is GC%, second column is read count
2. output.GC_plot.r: R script to generate pdf file.
3. output.GC_plot.pdf: graphical output generated from R script. 

.. image:: http://rseqc.sourceforge.net/_images/read_gc.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>