annotate rnafold.xml @ 0:78d673470d45 draft

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