annotate rna2dfold.xml @ 2:2c5a9f01ba08 draft default tip

Uploaded
author rnateam
date Mon, 09 Feb 2015 13:18:14 -0500
parents 031ad3250176
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
1 <tool id="rna2dfold" name="RNA2Dfold" version="2.1.6.0">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
2 <description>explore structure space between two reference structures</description>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
3 <expand macro="requirements" />
031ad3250176 Uploaded
rnateam
parents:
diff changeset
4 <expand macro="version_command" />
031ad3250176 Uploaded
rnateam
parents:
diff changeset
5 <expand macro="stdio" />
031ad3250176 Uploaded
rnateam
parents:
diff changeset
6 <macros>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
7 <token name="@EXECUTABLE@">RNA2Dfold</token>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
8 <import>macros.xml</import>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
9 </macros>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
10 <command>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
11 <![CDATA[
031ad3250176 Uploaded
rnateam
parents:
diff changeset
12 RNA2Dfold -T $temperature -d $dangling --stochBT=$nrbt
031ad3250176 Uploaded
rnateam
parents:
diff changeset
13 #if int($nk) > -1 and int($nl) > -1
031ad3250176 Uploaded
rnateam
parents:
diff changeset
14 --neighborhood=$nk:$nl
031ad3250176 Uploaded
rnateam
parents:
diff changeset
15 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
16 #if $varExists('$pfselect.pfscaling')
031ad3250176 Uploaded
rnateam
parents:
diff changeset
17 --partfunc --pfScale=$pfselect.pfscaling
031ad3250176 Uploaded
rnateam
parents:
diff changeset
18 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
19 #if $varExists('$advancedOptions.noconversion')
031ad3250176 Uploaded
rnateam
parents:
diff changeset
20 #if $advancedOptions.noconversion
031ad3250176 Uploaded
rnateam
parents:
diff changeset
21 --noconv
031ad3250176 Uploaded
rnateam
parents:
diff changeset
22 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
23 #if $advancedOptions.nogu
031ad3250176 Uploaded
rnateam
parents:
diff changeset
24 --noGU
031ad3250176 Uploaded
rnateam
parents:
diff changeset
25 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
26 #if $advancedOptions.noclosinggu
031ad3250176 Uploaded
rnateam
parents:
diff changeset
27 --noClosingGU
031ad3250176 Uploaded
rnateam
parents:
diff changeset
28 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
29 #if $advancedOptions.notetra
031ad3250176 Uploaded
rnateam
parents:
diff changeset
30 --noTetra
031ad3250176 Uploaded
rnateam
parents:
diff changeset
31 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
32 --maxDist1=$maxK
031ad3250176 Uploaded
rnateam
parents:
diff changeset
33 --maxDist2=$maxL
031ad3250176 Uploaded
rnateam
parents:
diff changeset
34 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
35 < $custom_input > $out_file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
36 ]]>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
37 </command>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
38 <inputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
39 <param format="txt" name="custom_input" type="data" label="Custom File"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
40 <param name="temperature" size="6" type="float" value="37.0" label="Temperature [°C]" help="-T"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
41 <param name="nrbt" type="integer" value="1" label="number of backtrack of Boltzmann samples" help="--stochBT=INT"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
42 <param name="nk" type="integer" value="-1" label="k distance to first reference structure of neighborhood in which to backtrack" help="--neighborhood=k:l"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
43 <param name="nl" type="integer" value="-1" label="l distance to second reference structure of neighborhood in which to backtrack" help="--neighborhood=k:l"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
44 <param name="dangling" type="select" label="how to treat dangling end energies" help="-d">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
45 <option value="2" selected="true">unpaired bases participate in all dangling ends (2)</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
46 <option value="0">ignore dangling ends (0)</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
47 <option value="1">unpaired bases participate in one dangling end only (1)</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
48 <option value="3">allow coaxial stacking (3)</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
49 </param>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
50 <param name="circular" type="boolean" checked="false" label="assume circular RNA structure" help="--circ"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
51 <conditional name="pfselect">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
52 <param name="pf" type="select" label="calculate partition function" help="--partfunc">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
53 <option value="no">no</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
54 <option value="yes">yes</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
55 </param>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
56 <when value="yes">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
57 <param name="pfscaling" size="6" type="float" value="1.0" label="scaling factor for the partition function"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
58 </when>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
59 </conditional>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
60
031ad3250176 Uploaded
rnateam
parents:
diff changeset
61 <conditional name="advancedOptions">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
62 <param name="advancedSelector" type="select" label="advanced options">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
63 <option value="basic">basic Options</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
64 <option value="advanced">advanced Options</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
65 </param>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
66 <when value="advanced">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
67 <param name="maxK" type="integer" value="50" label="Maximum distance to first reference structure" help="--maxDist1=INT"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
68 <param name="maxL" type="integer" value="50" label="Maximum distance to second reference structure" help="--maxDist2=INT"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
69 <param name="noconversion" type="boolean" checked="false" label="no conversion" help="--noconv do not convert thymine to uracile (T -> U)."/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
70 <param name="gquad" type="boolean" checked="false" label="G Quadruplex formation" help="-g take into account G Quadruplex formation"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
71 <param name="nogu" type="boolean" checked="false" label="No GU pairing" help="--noGU don't allow pairing of G and U."/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
72 <param name="noclosinggu" type="boolean" checked="false" label="No GU pairing at the ends" help="--noClosingGU don't allow pairing of G and U at the ends of helices."/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
73 <param name="notetra" type="boolean" checked="false" label="No stabilization for loops, hairpins etc." help="--noTetra"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
74 </when>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
75 </conditional>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
76 </inputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
77 <outputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
78 <data format="txt" name="out_file"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
79 </outputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
80 <tests>
2
2c5a9f01ba08 Uploaded
rnateam
parents: 0
diff changeset
81 <test>
2c5a9f01ba08 Uploaded
rnateam
parents: 0
diff changeset
82 <param name="custom_input" value="rna2dfold_input1.txt"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 0
diff changeset
83 <param name="nrbt" value="0"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 0
diff changeset
84 <output name="out_file1" file="rna2dfold_result1.txt"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 0
diff changeset
85 </test>
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
86 </tests>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
87 <help>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
88 <![CDATA[
031ad3250176 Uploaded
rnateam
parents:
diff changeset
89 **RNA2Dfold**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
90
031ad3250176 Uploaded
rnateam
parents:
diff changeset
91 The program partitions the secondary structure space into (basepair)distance
031ad3250176 Uploaded
rnateam
parents:
diff changeset
92 classes according to two fixed reference structures. It expects a sequence and
031ad3250176 Uploaded
rnateam
parents:
diff changeset
93 two secondary structures in dot-bracket notation as its inputs. For each
031ad3250176 Uploaded
rnateam
parents:
diff changeset
94 distance class, the MFE representative, Boltzmann probabilities and Gibbs free
031ad3250176 Uploaded
rnateam
parents:
diff changeset
95 energy is computed. Additionally, a stochastic backtracking routine allows to
031ad3250176 Uploaded
rnateam
parents:
diff changeset
96 produce samples of representative suboptimal secondary structures from each
031ad3250176 Uploaded
rnateam
parents:
diff changeset
97 partition.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
98 The k-distance corresponds to the distance to the first reference structure, and
031ad3250176 Uploaded
rnateam
parents:
diff changeset
99 the l-distance corresponds to the distance to the second reference structure
031ad3250176 Uploaded
rnateam
parents:
diff changeset
100
031ad3250176 Uploaded
rnateam
parents:
diff changeset
101 -----
031ad3250176 Uploaded
rnateam
parents:
diff changeset
102
031ad3250176 Uploaded
rnateam
parents:
diff changeset
103 **Input format**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
104
031ad3250176 Uploaded
rnateam
parents:
diff changeset
105 RNA2Dfold requires one input file in the following format
031ad3250176 Uploaded
rnateam
parents:
diff changeset
106
031ad3250176 Uploaded
rnateam
parents:
diff changeset
107 - 1st line: RNA sequence
031ad3250176 Uploaded
rnateam
parents:
diff changeset
108 - 2nd line: first reference structure in dot-bracket format
031ad3250176 Uploaded
rnateam
parents:
diff changeset
109 - 3rd line: second reference structure in dot-bracket format
031ad3250176 Uploaded
rnateam
parents:
diff changeset
110
031ad3250176 Uploaded
rnateam
parents:
diff changeset
111 ------
031ad3250176 Uploaded
rnateam
parents:
diff changeset
112
031ad3250176 Uploaded
rnateam
parents:
diff changeset
113 **Outputs**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
114
031ad3250176 Uploaded
rnateam
parents:
diff changeset
115 - text output with several secondary structures and its energies
031ad3250176 Uploaded
rnateam
parents:
diff changeset
116
031ad3250176 Uploaded
rnateam
parents:
diff changeset
117 ]]>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
118 </help>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
119 <expand macro="requirements" />
031ad3250176 Uploaded
rnateam
parents:
diff changeset
120 </tool>