annotate rnaduplex.xml @ 0:78d673470d45 draft

Imported from capsule None

<tool id="rnaduplex" name="RNAduplex" version="2.1.6.0">
    <description>Compute the structure upon hybridization of two RNA strands</description>
    <expand macro="requirements" />
    <expand macro="version_command" />
    <expand macro="stdio" />
    <macros>
        <token name="@EXECUTABLE@">RNAduplex</token>
        <import>macros.xml</import>
    </macros>
    <command>
<![CDATA[
        RNAduplex < $input > $tabularFile
        -T$temperature -d$dangling --deltaEnergy=$denergy
        #if $varExists('$advancedOptions.noconversion')
            $advancedOptions.noconversion
            $advancedOptions.nolp
            $advancedOptions.nogu
            $advancedOptions.noclosinggu
            $advancedOptions.notetra
        #end if
]]>
    </command>

    <inputs>
        <param format="fasta" name="input" type="data" label="Fasta file"/>
        <param name="temperature" size="6" type="float" value="37.0" label="temperature [°C]" help="-T"/>
        <param name="dangling" type="select" label="how to treat dangling end energies" help="-d">
            <option value="0">0: ignore dangling ends</option>
            <option value="1">1: unpaired bases participate in one dangling end only</option>
            <option value="2" selected="True">2: unpaired bases participate in all dangling ends</option>
            <option value="3">3: allow coaxial stacking</option>
        </param>
        <param name="denergy" size="6" type="float" value="0.0" label="delta energy range [kcal/mol] for suboptimal structures" help="-deltaEnergy"/>
        <param name="sorted" type="boolean" truevalue="--sorted" falsevalue="" checked="false" label="Sort by energy" help="--sorted"/>

        <conditional name="advancedOptions">
            <param name="advancedSelector" type="select" label="advanced options">
                <option value="basic">basic Options</option>
                <option value="advanced">advanced Options</option>
            </param>
            <when value="advanced">
                <param name="noconversion" type="boolean" truevalue="--noconv" falsevalue="" checked="false" label="No converstion from T->U" help="--noconv"/>
                <param name="nolp" type="boolean" truevalue="--noLP" falsevalue="" checked="false" label="No lonely pairs" help="--noLP  don't allow lonely pairs."/>
                <param name="nogu" type="boolean" truevalue="--noGU" falsevalue="" checked="false" label="No GU pairing" help="--noGU  don't allow pairing of G and U."/>
                <param name="noclosinggu" type="boolean" truevalue="--noClosingGU" falsevalue="" checked="false" label="No GU pairing at the ends" help="--noClosingGU  don't allow pairing of G and U at the ends of helices."/>
                <param name="notetra" type="boolean" truevalue="--noTetra" falsevalue="" checked="false" label="No stabilization for loops, hairpins etc." help="--noTetra"/>
            </when>
        </conditional>
    </inputs>
    <outputs>
        <data format="txt" name="tabularFile"/>
    </outputs>
    <tests>
    </tests>
    <help>
<![CDATA[
**RNAduplex**
RNA duplex reads two RNA sequences and computes optimal and suboptimal secondary structures for their hybridization. The calculation is simplified by allowing only inter−molecular base pairs, for the general case use RNAcofold. The computed optimal and suboptimal structure are written to stdout, one structure per line. Suboptimal structures are computed with energy in a certain range of the optimum (kcal/mol). Default is calculation of mfe structure only.

-----

**Input format**

RNAduplex requires one input file in Fasta format. The secondary strucures will be calculated pairwise: 1st sequence with 2nd sequence, 3rd sequence with 4th sequence, etc.

------

**Outputs**

Each line consist of: The structure in dot bracket format with a "&" separating the two strands. The range of the structure in the two sequences in the format "from,to : from,to"; the energy of duplex structure in kcal/mol. The format is especially useful for computing the hybrid structure between a small probe sequence and a long target sequence.


]]>
    </help>
    <expand macro="requirements" />
</tool>