annotate blockbuster.xml @ 0:6ae946589f04 draft

initial Uploaded

<tool id="blockbuster" name="blockbuster" version="0.1">
    <description>detects blocks of overlapping reads using a gaussian-distribution approach</description>
    <requirements>
        <requirement type="package" version="0.0.1">blockbuster</requirement>
    </requirements>
    <command>
        blockbuster.x 
            -distance $distance 
            -minClusterHeight $minClusterHeight 
            -minBlockHeight $minBlockHeight 
            -scale $scale 
            -merge $merge 
            -tagFilter $tagFilter 
            -print $print 
            $input
            
            > $output
    </command>
    <inputs>
        <param name="input" type="data" format="bed" label="BED file containing read expressions"/>
        <param name="distance" type="integer" value="40" size="5" label="minimum distance between two clusters"/>
        <param name="minClusterHeight" type="float" value="50" size="5" label="minimum height (readno) of a cluster"/>
        <param name="minBlockHeight" type="float" value="1" size="5" label="minimum height (readno) of a block"/>
        <param name="scale" type="float" value="0.5" size="5" label="scale stddev for a single read"/>
        <param name="merge" type="integer" value="0" size="5" label="merge reads with almost similar means"/>
        <param name="tagFilter" type="integer" value="0" size="5" label="skip tags with expression smaller than this value"/>
        <param name="print" type="select" label="Type of output" >
            <option value="1">blocks</option>
            <option value="2" selected="True">reads</option>
        </param>
    </inputs>

    <outputs>
        <data format="tabular" name="output" label="blockbuster on ${on_string}"/>
    </outputs>
    <help>

.. class:: infomark

**What it does** 

Blockbuster_ detects blocks of overlapping reads using a gaussian-distribution approach.


Once short read sequences are mapped to a reference genome, one will face the problem of dividing consecutive reads into blocks to detect specific expression patterns. Due to biological variability and sequencing inaccuracies, the read arrangement does not always show exact block boundaries. The blockbuster tool automatically assigns reads to blocks and gives a unique chance to actually see the different origins where the short reads come from. 

.. _Blockbuster: http://hoffmann.bioinf.uni-leipzig.de/LIFE/blockbuster.html


**References**


If you use this program in your work you might want to cite:

Langenberger D, Bermudez-Santana C, Hertel J, Hoffmann S, Khaitovitch P, Stadler PF: "Evidence for Human microRNA-Offset RNAs in Small RNA Sequencing Data", Bioinformatics (2009) vol. 25 (18) pp. 2298-301


    </help>
</tool>