annotate inner_distance.xml @ 49:6b33e31bda10 draft

Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2

<tool id="rseqc_inner_distance" name="Inner Distance" version="2.4galaxy1">
    <description>calculate the inner distance (or insert size) between two paired RNA reads</description>

    <macros>
        <import>rseqc_macros.xml</import>
    </macros>

    <requirements>
        <expand macro="requirement_package_r" />
        <expand macro="requirement_package_numpy" />
        <expand macro="requirement_package_rseqc" />
    </requirements>

    <expand macro="stdio" />

    <version_command><![CDATA[inner_distance.py --version]]></version_command>

    <command><![CDATA[
        inner_distance.py -i $input -o output -r $refgene
            --sample-size $sample_size
            --lower-bound $lowerBound
            --upper-bound $upperBound
            --step $step
            --mapq $mapq
        ]]>
    </command>

    <inputs>
        <param name="input" type="data" format="bam,sam" label="input bam/sam file" help="(--input-file)" />
        <param name="refgene" type="data" format="bed" label="reference gene model" help="(--refgene)" />
        <param name="sample_size" type="integer" label="Number of read-pairs used to estimate inner distance (default = 1000000)" value="1000000" help="(--sample-size)"/>
        <param name="lowerBound" type="integer" value="-250" label="Lower bound (bp, default=-250)" help="Used for plotting histogram (--lower-bound)"/>
        <param name="upperBound" type="integer" value="250" label="Upper bound (bp, default=250)" help="Used for plotting histogram (--upper-bound)"/>
        <param name="step" type="integer" value="5" label="Step size of histogram (bp, default=5)" help="(--step)"/>
        <param name="mapq" type="integer" label="Minimum mapping quality (default=30)" help="Minimum phred scale mapping quality to consider a read 'uniquely mapped' (--mapq)" value="30" />
    </inputs>

    <outputs>
        <data format="txt" name="outputtxt" from_work_dir="output.inner_distance.txt" label="${tool.name} on ${on_string} (Text)"/>
        <data format="txt" name="outputfreqtxt" from_work_dir="output.inner_distance_freq.txt" label="${tool.name} on ${on_string} (Freq Text)" />
        <data format="pdf" name="outputpdf" from_work_dir="output.inner_distance_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
        <data format="txt" name="outputr" from_work_dir="output.inner_distance_plot.r" label="${tool.name} on ${on_string} (R Script)" />
    </outputs>

    <tests>
        <test>
            <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
            <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed"/>
            <output name="outputtxt" file="output.inner_distance.txt"/>
            <output name="outputfreqtxt" file="output.inner_distance_freq.txt"/>
            <output name="outputpdf" file="output.inner_distance_plot.pdf"/>
            <output name="outputr" file="output.inner_distance_plot.r"/>
        </test>
    </tests>

    <help><![CDATA[
inner_distance.py
+++++++++++++++++

This module is used to calculate the inner distance (or insert size) between two paired RNA
reads. The distance is the mRNA length between two paired fragments. We first determine the
genomic (DNA) size between two paired reads: D_size = read2_start - read1_end, then

* if two paired reads map to the same exon: inner distance = D_size
* if two paired reads map to different exons:inner distance = D_size - intron_size
* if two paired reads map non-exonic region (such as intron and intergenic region): inner distance = D_size
* The inner_distance might be a negative value if two fragments were overlapped.

NOTE: Not all read pairs were used to estimate the inner distance distribution. Those low
quality, PCR duplication, multiple mapped reads were skipped.

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

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

Reference gene model
    Gene model in BED format.

Estimated Upper/Lower Bounds (defaults=250 and -250)
    Estimated upper/lower bounds of inner distance (bp).

Step size (default=5)
    Step size of histogram


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

1. output.inner_distance.txt:
    - first column is read ID
    -second column is inner distance. Could be negative value if PE reads were overlapped or mapping error (e.g. Read1_start &lt; Read2_start, while Read1_end >> Read2_end due to spliced mapping of read1)
    - third column indicates how paired reads were mapped: PE_within_same_exon, PE_within_diff_exon,PE_reads_overlap
2. output..inner_distance_freq.txt:
    - inner distance starts
    - inner distance ends
    - number of read pairs
    - note the first 2 columns are left side half open interval
3. output.inner_distance_plot.r: R script to generate histogram
4. output.inner_distance_plot.pdf: histogram plot

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

    <expand macro="citations" />

</tool>