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

Uploaded
author rnateam
date Mon, 09 Feb 2015 13:18:14 -0500
parents b82c46050674
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
1 <tool id="rnafold" name="RNAfold" version="2.1.6.0">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
2 <description>Calculate minimum free energy secondary structures and partition function of RNAs</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@">RNAfold</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 RNAfold
031ad3250176 Uploaded
rnateam
parents:
diff changeset
13 -T $temperature
031ad3250176 Uploaded
rnateam
parents:
diff changeset
14 --dangles=$dangling
031ad3250176 Uploaded
rnateam
parents:
diff changeset
15 #if $measelect.mea == "yes":
031ad3250176 Uploaded
rnateam
parents:
diff changeset
16 --MEA=$measelect.meavalue
031ad3250176 Uploaded
rnateam
parents:
diff changeset
17 #else
031ad3250176 Uploaded
rnateam
parents:
diff changeset
18 $measelect.pf
031ad3250176 Uploaded
rnateam
parents:
diff changeset
19 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
20 #if $varExists('$advancedOptions.nogu'):
031ad3250176 Uploaded
rnateam
parents:
diff changeset
21 $advancedOptions.noconversion
031ad3250176 Uploaded
rnateam
parents:
diff changeset
22 $advancedOptions.gquad
031ad3250176 Uploaded
rnateam
parents:
diff changeset
23 $advancedOptions.nolp
031ad3250176 Uploaded
rnateam
parents:
diff changeset
24 $advancedOptions.nogu
031ad3250176 Uploaded
rnateam
parents:
diff changeset
25 $advancedOptions.noclosinggu
031ad3250176 Uploaded
rnateam
parents:
diff changeset
26 $advancedOptions.canonicalonly
031ad3250176 Uploaded
rnateam
parents:
diff changeset
27 $advancedOptions.circular
031ad3250176 Uploaded
rnateam
parents:
diff changeset
28 #end if
031ad3250176 Uploaded
rnateam
parents:
diff changeset
29
031ad3250176 Uploaded
rnateam
parents:
diff changeset
30 < $fasta_input
031ad3250176 Uploaded
rnateam
parents:
diff changeset
31
031ad3250176 Uploaded
rnateam
parents:
diff changeset
32 > $tabular_file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
33 ]]>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
34 </command>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
35
031ad3250176 Uploaded
rnateam
parents:
diff changeset
36 <inputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
37 <param format="fasta" name="fasta_input" type="data" label="FASTA file"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
38 <param name="temperature" size="6" type="float" value="37.0" label="Temperature [°C]" help="-T"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
39 <param name="dangling" type="select" label="how to treat dangling end energies" help="-d">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
40 <option value="0">0: ignore dangling ends</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
41 <option value="1">1: unpaired bases participate in one dangling end only</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
42 <option value="2" selected="True">2: unpaired bases participate in all dangling ends</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
43 <option value="3">3: allow coaxial stacking</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
44 </param>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
45 <conditional name="measelect">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
46 <param name="mea" type="select" label="Calculate Maximum Expected accuracy" help="--MEA">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
47 <option value="no">No</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
48 <option value="yes">Yes</option>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
49 </param>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
50 <when value="yes">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
51 <param name="meavalue" size="6" type="float" value="1.0" label="Gamma Value"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
52 </when>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
53 <when value="no">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
54 <param name="pf" type="boolean" checked="false" truevalue="--partfunc" falsevalue="" label="Calculate Partition Function" help="--partfunc"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
55 </when>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
56 </conditional>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
57 <conditional name="advancedOptions">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
58 <param name="advancedSelector" type="boolean" checked="false" label=" advanced options"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
59 <when value="true">
031ad3250176 Uploaded
rnateam
parents:
diff changeset
60 <param name="noconversion" type="boolean" truevalue="--noconv" falsevalue="" checked="false" label="no conversion" help="--noconv do not convert thymine to uracile (T -> U)."/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
61 <param name="gquad" type="boolean" truevalue="--gquad" falsevalue="" checked="false" label="G Quadruplex formation" help="-g take into account G Quadruplex formation"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
62 <param name="nolp" type="boolean" truevalue="--noLP" falsevalue="" checked="false" label="No lonely pairs" help="--noLP don't allow lonely pairs."/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
63 <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"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
64 <param name="canonicalonly" type="boolean" truevalue="--canonicalBPonly" falsevalue="" checked="false" label="Canonical basepairing only" help="--canonicalBPonly"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
65 <param name="circular" type="boolean" truevalue="--circ" falsevalue="" checked="false" label="Assume circular RNA structure" help="--circ"/>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
66 </when>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
67 </conditional>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
68 </inputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
69 <outputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
70 <data format="tabular" name="tabular_file"/>
1
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
71 <collection name="sequence_outputs" type="list" label="rna_eps outputs">
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
72 <discover_datasets pattern="(?P&lt;designation&gt;.+)_ss\.ps" ext="eps" />
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
73 </collection>
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
74 <collection name="matrix_outputs" type="list" label="rna_eps outputs">
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
75 <filter>measelect['pf'] is True</filter>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
76 <discover_datasets pattern="(?P&lt;designation&gt;.+)_dp\.ps" ext="rna_eps" visible="true"/>
1
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
77 </collection>
b82c46050674 Uploaded
rnateam
parents: 0
diff changeset
78
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
79 </outputs>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
80 <tests>
2
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
81 <test>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
82 <param name="fasta_input" value="rnafold_input1.fa"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
83 <output name="out_file1" file="rnafold_result1.txt"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
84 </test>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
85 <test>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
86 <param name="fasta_input" value="rnafold_input2.fa"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
87 <param name="temperature" value="75"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
88 <output name="out_file1" file="rnafold_result2.txt"/>
2c5a9f01ba08 Uploaded
rnateam
parents: 1
diff changeset
89 </test>
0
031ad3250176 Uploaded
rnateam
parents:
diff changeset
90 </tests>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
91 <help>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
92 <![CDATA[
031ad3250176 Uploaded
rnateam
parents:
diff changeset
93 **RNAfold**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
94
031ad3250176 Uploaded
rnateam
parents:
diff changeset
95 The program reads RNA sequences, calculates their minimum free
031ad3250176 Uploaded
rnateam
parents:
diff changeset
96 energy (mfe) structure and the mfe structure in dot-bracket notation.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
97
031ad3250176 Uploaded
rnateam
parents:
diff changeset
98 If the -p option was given it also computes the
031ad3250176 Uploaded
rnateam
parents:
diff changeset
99 partition function (pf) and base pairing probability matrix.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
100
031ad3250176 Uploaded
rnateam
parents:
diff changeset
101 The dot plot of the base pairing probability matrix shows a matrix of squares with area proportional to the pairing
031ad3250176 Uploaded
rnateam
parents:
diff changeset
102 probability in the upper right half, and one square for each pair in the
031ad3250176 Uploaded
rnateam
parents:
diff changeset
103 minimum free energy structure in the lower left half. For each pair i-j with
031ad3250176 Uploaded
rnateam
parents:
diff changeset
104 probability p>10E-6 there is a line of the form
031ad3250176 Uploaded
rnateam
parents:
diff changeset
105
031ad3250176 Uploaded
rnateam
parents:
diff changeset
106 i j sqrt(p) ubox
031ad3250176 Uploaded
rnateam
parents:
diff changeset
107
031ad3250176 Uploaded
rnateam
parents:
diff changeset
108 in the PostScript file, so that the pair probabilities can be easily extracted.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
109
031ad3250176 Uploaded
rnateam
parents:
diff changeset
110 The sequences have to be provided in FASTA format. The first word (max. 42 char) of the FASTA header will be used for output file names. PostScript files "name_ss.ps" and "name_dp.ps" are produced for the structure and dot plot, respectively.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
111 The program will read the whole FASTA input file and provide output for each found sequence.
031ad3250176 Uploaded
rnateam
parents:
diff changeset
112
031ad3250176 Uploaded
rnateam
parents:
diff changeset
113
031ad3250176 Uploaded
rnateam
parents:
diff changeset
114 -----
031ad3250176 Uploaded
rnateam
parents:
diff changeset
115
031ad3250176 Uploaded
rnateam
parents:
diff changeset
116 **Input format**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
117
031ad3250176 Uploaded
rnateam
parents:
diff changeset
118 RNAfold requires one input file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
119 - FASTA file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
120
031ad3250176 Uploaded
rnateam
parents:
diff changeset
121 ------
031ad3250176 Uploaded
rnateam
parents:
diff changeset
122
031ad3250176 Uploaded
rnateam
parents:
diff changeset
123 **Outputs**
031ad3250176 Uploaded
rnateam
parents:
diff changeset
124
031ad3250176 Uploaded
rnateam
parents:
diff changeset
125 - Secondary structures in dot-bracket notation
031ad3250176 Uploaded
rnateam
parents:
diff changeset
126
031ad3250176 Uploaded
rnateam
parents:
diff changeset
127 - several possible postscript images bundled together in a tar file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
128 - secondary structure for each sequence in the input file
031ad3250176 Uploaded
rnateam
parents:
diff changeset
129 - if partition function is calculated (--MEA or --partfunc is set) then also the pairing probabilty matrix is generated for each sequence
031ad3250176 Uploaded
rnateam
parents:
diff changeset
130
031ad3250176 Uploaded
rnateam
parents:
diff changeset
131 ]]>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
132 </help>
031ad3250176 Uploaded
rnateam
parents:
diff changeset
133 <expand macro="citations" />
031ad3250176 Uploaded
rnateam
parents:
diff changeset
134 </tool>