RNALfold − manual page for RNALfold 2.3.4
calculate locally stable secondary structures of RNAs
stable RNA secondary structure with a maximal base pair
span. For a sequence of length n and a base pair span of L
the algorithm uses only O(n+L*L) memory and O(n*L*L) CPU
time. Thus it is practical to "scan" very large
genomes for short RNA structures. Output consists of a list
of secondary structure components of size <= L, one entry
per line. Each output line contains the predicted local
structure its energy in kcal/mol and the starting position
of the local structure.
Print help and exit
Print help, including all details and hidden options, and exit
Print help, including hidden options, and exit
Print version and exit
Below are command line options which alter the general behavior of this program
Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with j−i>span will be allowed.
Do not automatically substitude nucleotide "T" with "U"
Print output to file instead of stdout
This option may be used to write all output to output files rather than printing to stdout. The default filename is "RNALfold_output.lfold" if no FASTA header precedes the input sequences and the −−auto−id feature is inactive. Otherwise, output files with the scheme "prefix.lfold" are generated, where the "prefix" is taken from the sequence id. The user may specify a single output file name for all data generated from the input by supplying an optional string as argument to this parameter. In case a file with the same filename already exists, any output of the program will be appended to it.
Read a file instead of reading from stdin
The default behavior of RNALfold is to read input from stdin. Using this parameter the user can specify an input file name where data is read from.
Automatically generate an ID for each sequence. (default=off)
The default mode of RNALfold is to automatically determine an ID from the input sequence data if the input file format allows to do that. Sequence IDs are usually given in the FASTA header of input sequences. If this flag is active, RNALfold ignores any IDs retrieved from the input and automatically generates an ID for each sequence. This ID consists of a prefix and an increasing number. This flag can also be used to add a FASTA header to the output even if the input has none.
Prefix for automatically generated IDs (as used in output file names)
If this parameter is set, each sequence will be prefixed with the provided string. Hence, the output files will obey the following naming scheme: "prefix_xxxx.lfold" where xxxx is the sequence number. Note: Setting this parameter implies −−auto−id.
Change the delimiter between prefix and increasing number for automatically generated IDs (as used in output file names)
This parameter can be used to change the default delimiter "_" between
the prefix string and the increasing number for automatically generated ID.
Specify the number of digits of the counter in automatically generated alignment IDs.
When alignments IDs are automatically generated, they receive an increasing number, starting with 1. This number will always be left−padded by leading zeros, such that the number takes up a certain width. Using this parameter, the width can be specified to the users need. We allow numbers in the range [1:18]. This option implies −−auto−id.
Specify the first number in automatically generated alignment IDs.
When sequence IDs are automatically generated, they receive an increasing number, usually starting with 1. Using this parameter, the first number can be specified to the users requirements. Note: negative numbers are not allowed. Note: Setting this parameter implies to ignore any IDs retrieved from the input data, i.e. it activates the −−auto−id flag.
Change the delimiting character that is used
for sanitized filenames
This parameter can be used to change the delimiting character used while sanitizing filenames, i.e. replacing invalid characters. Note, that the default delimiter ALWAYS is the first character of the "ID delimiter" as supplied through the −−id−delim option. If the delimiter is a whitespace character or empty, invalid characters will be simply removed rather than substituted.
Use full FASTA header to create filenames
This parameter can be used to deactivate the default behavior of limiting output filenames to the first word of the sequence ID. Consider the following example: An input with FASTA header ">NM_0001 Homo Sapiens some gene" usually produces output files with the prefix "NM_0001" without the additional data available in the FASTA header, e.g. "NM_0001.lfold". With this flag set, no truncation of the output filenames is performed, i.e. output filenames receive the full FASTA header data as prefixes. Note, however, that invalid characters (such as whitespace) will be substituted by a delimiting character or simply removed, (see also the parameter option −−filename−delim).
Select additional algorithms which should be included in the calculations. The Minimum free energy (MFE) and a structure representative are calculated in any case.
Activate z−score computation. An optional argument may be supplied to set the threshold Due to parsing the commandline parameters a negative value should be given immediately after "z" without spaces e.g. −z−4.9
Incoorporate G−Quadruplex formation into the structure prediction algorithm
Rescale energy parameters to a temperature of temp C. Default is 37C.
Do not include special tabulated stabilizing energies for tri−, tetra− and hexaloop hairpins. Mostly for testing.
How to treat "dangling end" energies for bases adjacent to helices in free ends and multi−loops
With −d1 only unpaired bases can participate in at most one dangling end, this is the default for mfe folding but unsupported for the partition function folding.
With −d2 this check is ignored, dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the default for partition function folding (−p). The option −d0 ignores dangling ends altogether (mostly for debugging). With −d3 mfe folding will allow coaxial stacking of adjacent helices in multi−loops. At the moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3 and works only for mfe folding.
Note that by default (as well as with −d1 and −d3) pf and mfe folding treat dangling ends differently. Use −d2 in addition to −p to ensure that both algorithms use the same energy model.
Produce structures without lonely pairs (helices of length 1).
For partition function folding this only disallows pairs that can only occur isolated. Other pairs may still occasionally occur as helices of length 1.
Do not allow GU pairs
Do not allow GU pairs at the end of helices
Read energy parameters from paramfile, instead of using the default parameter set.
A sample parameter file should accompany your distribution. See the RNAlib documentation for details on the file format.
Allow other pairs in addition to the usual AU,GC,and GU pairs.
Its argument is a comma separated list of additionally allowed pairs. If the first character is a "−" then AB will imply that AB and BA are allowed pairs. e.g. RNALfold −nsp −GA will allow GA and AG pairs. Nonstandard pairs are given 0 stacking energy.
Rarely used option to fold sequences from the artificial ABCD... alphabet, where A pairs B, C−D etc. Use the energy parameters for GC (−e 1) or AU (−e 2) pairs.
If you use this program in your work you might want to cite:
R. Lorenz, S.H. Bernhart, C. Hoener zu Siederdissen, H. Tafer, C. Flamm, P.F. Stadler and I.L. Hofacker (2011), "ViennaRNA Package 2.0", Algorithms for Molecular Biology: 6:26
I.L. Hofacker, W. Fontana, P.F. Stadler, S. Bonhoeffer, M. Tacker, P. Schuster (1994), "Fast Folding and Comparison of RNA Secondary Structures", Monatshefte f. Chemie: 125, pp 167-188
I.L. Hofacker, B. Priwitzer, and P.F. Stadler (2004), "Prediction of Locally Stable RNA Secondary Structures for Genome-Wide Surveys", Bioinformatics: 20, pp 186-190
M. Zuker, P. Stiegler (1981), "Optimal computer folding of large RNA sequences using thermodynamic and auxiliary information", Nucl Acid Res: 9, pp 133-148
J.S. McCaskill (1990), "The equilibrium partition function and base pair binding probabilities for RNA secondary structures", Biopolymers: 29, pp 1105-1119
The energy parameters are taken from:
D.H. Mathews, M.D. Disney, D. Matthew, J.L. Childs, S.J. Schroeder, J. Susan, M. Zuker, D.H. Turner (2004), "Incorporating chemical modification constraints into a dynamic programming algorithm for prediction of RNA secondary structure", Proc. Natl. Acad. Sci. USA: 101, pp 7287-7292
D.H Turner, D.H. Mathews (2009), "NNDB: The nearest neighbor parameter database for predicting stability of nucleic acid secondary structure", Nucleic Acids Research: 38, pp 280-282
Ivo L Hofacker, Peter F Stadler, Ronny Lorenz
If in doubt our program is right, nature is at fault. Comments should be sent to firstname.lastname@example.org.