annotate miranda.xml @ 2:9c8ff1bdd041 draft default tip

"planemo upload for repository https://github.com/TGAC/earlham-galaxytools/tree/master/tools/miranda commit a9aa47b387ab4d4ee8628956aaea80d7aabca936"

<tool id="miranda" name="miRanda" version="3.3a+galaxy1">
    <description>finds potential target sites for miRNAs in genomic sequences</description>
    <requirements>
        <requirement type="package" version="3.3a">miranda</requirement>
        <requirement type="package" version="3.9">python</requirement>
    </requirements>
    <version_command>miranda --version|grep 'miranda v'</version_command>
    <command detect_errors="exit_code"><![CDATA[
miranda '$microrna' '$query'
#if str($sc)
    -sc $sc
#end if
#if str($en)
    -en $en
#end if
-out '$raw_output'
&&
python '$__tool_directory__/miranda_parser.py' '$raw_output' '$tabular_output'
    ]]></command>
    <inputs>
        <param name="microrna" type="data" format="fasta" label="MicroRNA sequences" help="FASTA format" />
        <param name="query" type="data" format="fasta" label="Query sequences" help="FASTA format" />
        <param argument="-sc" type="float" min="0.0" value="140.0" optional="true" label="Alignment score threshold" help="Only alignments with score greater or equal to this value will be used for further analysis" />
        <param argument="-en" type="float" value="1.0" optional="true" label="Set energy threshold to -E kcal/mol" help="Only alignments with energy less or equal to this value will be used for further analysis. A negative value is required for filtering to occur" />
    </inputs>
    <outputs>
        <data name="raw_output" format="txt" label="${tool.name} on ${on_string}: raw output" />
        <data name="tabular_output" format="tabular" label="${tool.name} on ${on_string}: tabular output" />
    </outputs>
    <tests>
        <test>
            <param name="microrna" ftype="fasta" value="microrna.fasta" />
            <param name="query" ftype="fasta" value="query.fasta" />
            <output name="raw_output" file="raw_output.txt" lines_diff="4" />
        </test>
    </tests>
    <help><![CDATA[
miRanda is an algorithm for the detection of potential microRNA target sites in genomic sequences.

One or more miRNA sequences are scanned against all query sequences and potential target sites are reported. Potential target sites are identified using a two-step strategy. First a dynamic programming local alignment is carried out between the query miRNA sequence and the reference sequence. This alignment procedure scores based on sequence complementarity and not on sequence identity. In other words we look for A:U and G:C matches instead of A:A, G:G, etc. The G:U wobble bair is also permitted, but generally scores less than the more optimal matches.

The second phase of the algorithm takes high-scoring alignments (i.e. those above the alignment score threshold) detected from phase 1 and estimates the thermodynamic stability of RNA duplexes based on these alignments. This second phase of the method utilizes folding routines from the RNAlib library, which is part of the ViennaRNA package written by Ivo Hofacker. At this stage we generate a constrained fictional single-stranded RNA composed of the query sequence, a linker and the reference sequence (reversed). This structure is then folded using RNAlib and the minimum free energy (DG kcal/mol) is calculated for that structure.

Finally, detected targets with energies less than a chosen energy threshold are selected as potential target sites. Target site alignments passing both thresholds and other information is produced as output.

View the original miRanda manual: http://cbio.mskcc.org/microrna_data/manual.html
    ]]></help>
    <citations>
        <citation type="doi">10.1186/gb-2003-5-1-r1</citation>
    </citations>
</tool>