binaries/src/ViennaRNA/Progs/RNAcofold.ggo

   1 # Name of your program
   2 package "RNAcofold" # don't use package if you're using automake
   3
   4 purpose "calculate secondary structures of two RNAs with dimerization"
   5
   6 #usage "RNAcofold [options]\n"
   7 # Version of your program
   8 #version "2.0"   # don't use version if you're using automake
   9
  10
  11 # command line options passed to gengetopt
  12 args "--file-name=RNAcofold_cmdl --include-getopt --default-optional --func-name=RNAcofold_cmdline_parser --arg-struct-name=RNAcofold_args_info"
  13
  14
  15 description "The program works much like RNAfold, but allows to specify two RNA sequences wich are\
  16  then allowed to form a dimer structure. RNA sequences are read from stdin in the usual\
  17  format, i.e. each line of input corresponds to one sequence, except for lines starting\
  18  with \">\" which contain the name of the next sequence.\nTo compute the hybrid structure\
  19  of two molecules, the two sequences must be concatenated using the \'&\' character as\
  20  separator.\nRNAcofold can compute minimum free energy (mfe) structures, as well as\
  21  partition function (pf) and base pairing probability matrix (using the -p switch)\nSince\
  22  dimer formation is concentration dependent, RNAcofold can be used to compute equilibrium\
  23  concentrations for all five monomer and (homo/hetero)-dimer species, given input\
  24  concentrations for the monomers.\nOutput consists of the mfe structure in bracket\
  25  notation as well as PostScript structure plots and \"dot plot\" files containing the\
  26  pair probabilities, see the RNAfold man page for details. In the dot plots a cross marks\
  27  the chain break between the two concatenated sequences.\nThe program will continue to\
  28  read new sequences until a line consisting of the single character @ or an end of file\
  29  condition is encountered.\n\n"
  30
  31 # Options
  32 section "General Options"
  33 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  34
  35 option  "constraint"  C
  36 "Calculate structures subject to constraints.\n"
  37 details="The program reads first the\
  38  sequence, then a string containing constraints on the structure encoded with the symbols:\n\n. (no constraint\
  39  for this base)\n\n| (the corresponding base has to be paired\n\nx (the base is unpaired)\n\n< (base i is paired with\
  40  a base j>i)\n\n> (base i is paired with a base j<i)\n\nand matching brackets ( ) (base i pairs base j)\n\nWith the\
  41  exception of \"|\", constraints will disallow all pairs conflicting with the constraint. This is usually\
  42  sufficient to enforce the constraint, but occasionally a base may stay unpaired in spite of constraints. PF\
  43  folding ignores constraints of type \"|\".\n\n"
  44 flag
  45 off
  46
  47 option  "noconv"  -
  48 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  49 flag
  50 off
  51
  52 option "noPS"   -
  53 "Do not produce postscript output\n\n"
  54 flag
  55 off
  56
  57 section "Algorithms"
  58 sectiondesc="Select additional algorithms which should be included in the calculations.\nThe Minimum free energy\
  59  (MFE) and a structure representative are calculated in any case.\n\n"
  60
  61 option  "partfunc"  p
  62 "Calculate the partition function and base pairing probability matrix in\
  63  addition to the mfe structure. Default is calculation of mfe structure only.\n"
  64 details="In addition to the MFE structure\
  65  we print a coarse representation of the pair probabilities in form of a pseudo bracket notation, followed by\
  66  the ensemble free energy, as well as the centroid structure derived from the pair probabilities together with\
  67  its free energy and distance to the ensemble. Finally it prints the frequency of the mfe structure, and the\
  68  structural diversity (mean distance between the structures in the ensemble).\nSee the description of pf_fold()\
  69  and mean_bp_dist() and centroid() in the RNAlib documentation for details.\nNote that unless you also specify\
  70  -d2 or -d0, the partition function and mfe calculations will use a slightly different energy model. See the\
  71  discussion of dangling end options below.\n\nAn additionally passed value to this option changes the behavior\
  72  of partition function calculation:\n\n\
  73  In order to calculate the partition function but not the pair probabilities use the -p0 option and save about
  74  50% in runtime. This prints the ensemble free energy -kT ln(Z).\n\n"
  75 int
  76 default="1"
  77 argoptional
  78 optional
  79
  80 option "all_pf" a
  81 "Compute the partition function and free energies not only of the hetero-dimer consisting\
  82  of the two input sequences (the \"AB dimer\"), but also of the homo-dimers AA and BB as\
  83  well as A and B monomers.\n"
  84 details="The output will contain the free energies for each of these species, as well as\
  85  5 dot plots containing the conditional pair probabilities, called ABname5.ps, AAname5.ps\
  86  and so on. For later use, these dot plot files also contain the free energy of the\
  87  ensemble as a comment. Using -a automatically toggles the -p option.\n\n"
  88 flag
  89 off
  90
  91 option  "concentrations"  c
  92 "In addition to everything listed under the -a option, read in initial monomer concentrations\
  93  and compute the expected equilibrium concentrations of the 5 possible species (AB, AA, BB, A, B).\n"
  94 details="Start concentrations are read from stdin (unless the -f option is used) in [mol/l],\
  95  equilibrium concentrations are given realtive to the sum of the two inputs. An arbitrary number\
  96  of initial concentrations can be specified (one pair of concentrations per line).\n\n"
  97 flag
  98 off
  99
 100 option  "concfile"  f
 101 "Specify a file with initial concentrations for the to sequences."
 102 details="The table consits of arbitrary many lines with just two numbers (the concentration of\
 103  sequence A and B). This option will automatically toggle the -c (and thus -a and -p) options (see above).\n\n"
 104 string
 105 typestr="filename"
 106 optional
 107
 108 option  "pfScale" S
 109 "In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid\
 110  overflows).\n"
 111 details="The default is 1.07, useful values are 1.0 to 1.2. Occasionally needed\
 112  for long sequences.\nYou can also recompile the program to use double precision (see the README file).\n\n"
 113 double
 114 typestr="scaling factor"
 115 optional
 116 hidden
 117
 118 option  "bppmThreshold" -
 119 "Set the threshold for base pair probabilities included in the postscript output\n"
 120 details="By setting the threshold the base pair probabilities that are included in the\
 121  output can be varied. By default only those exceeding 1e-5 in probability will be shown as squares\
 122  in the dot plot. Changing the threshold to any other value allows for increase or decrease of data.\n\n"
 123 double
 124 typestr="<value>"
 125 optional
 126 default="1e-5"
 127 hidden
 128
 129 option  "gquad" g
 130 "Incoorporate G-Quadruplex formation into the structure prediction algorithm\n"
 131 flag
 132 off
 133
 134 section "Model Details"
 135
 136 option  "temp"  T
 137 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
 138 double
 139
 140 option  "noTetra" 4
 141 "Do not include special stabilizing energies for certain tetra-loops. Mostly for testing.\n\n"
 142 flag
 143 off
 144
 145 option  "dangles" d
 146 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
 147 details="\nWith -d1 only unpaired bases can participate in at most one dangling end, this is the\
 148  default for mfe folding but unsupported for the partition function folding.\n\nWith -d2 this check is ignored,\
 149  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
 150  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
 151  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
 152  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3\
 153  and works only for mfe folding.\n\nNote that by default (as well as with -d1 and -d3) pf and mfe folding\
 154  treat dangling ends differently. Use -d2 in addition to -p to ensure that both algorithms use the same\
 155  energy model.\n\n"
 156 int
 157 default="2"
 158 optional
 159
 160 option  "noLP"  -
 161 "Produce structures without lonely pairs (helices of length 1).\n"
 162 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
 163  pairs may still occasionally occur as helices of length 1.\n\n"
 164 flag
 165 off
 166
 167 option  "noGU"  -
 168 "Do not allow GU pairs\n\n"
 169 flag
 170 off
 171
 172 option  "noClosingGU" -
 173 "Do not allow GU pairs at the end of helices\n\n"
 174 flag
 175 off
 176
 177 option  "paramFile" P
 178 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
 179 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
 180  documentation for details on the file format.\n\n"
 181 string
 182 typestr="paramfile"
 183 optional
 184
 185 option  "nsp" -
 186 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 187 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 188  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 189  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 190  energy.\n\n"
 191 string
 192 optional
 193 hidden
 194
 195 option  "energyModel" e
 196 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 197  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 198 int
 199 optional
 200 hidden
 201
 202 option  "betaScale" -
 203 "Set the scaling of the Boltzmann factors\n"
 204 details="The argument provided with this option enables to scale the thermodynamic temperature\
 205  used in the Boltzmann factors independently from the temperature used to scale the individual\
 206  energy contributions of the loop types. The Boltzmann factors then become exp(-dG/(kT*betaScale))\
 207  where k is the Boltzmann constant, dG the free energy contribution of the state and T the\
 208  absolute temperature.\n\n"
 209 double
 210 default="1."
 211 optional
 212 hidden
 213
 214 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 215  rna@tbi.univie.ac.at.\n"