binaries/src/ViennaRNA/Progs/RNAalifold.ggo

   1 # Name of your program
   2 package "RNAalifold" # don't use package if you're using automake
   3 purpose "calculate secondary structures for a set of aligned RNAs"
   4 usage   "RNAalifold [options] <file1.aln>"
   5
   6 # Version of your program
   7 # version "2.0"   # don't use version if you're using automake
   8
   9
  10 # command line options passed to gengetopt
  11 args "--file-name=RNAalifold_cmdl --include-getopt --default-optional --unamed-opts --func-name=RNAalifold_cmdline_parser --arg-struct-name=RNAalifold_args_info"
  12
  13 description "Read aligned RNA sequences from stdin or file.aln and calculate\
  14  their minimum free energy (mfe) structure, partition function (pf) and base\
  15  pairing probability matrix. Currently, the input alignment has to be in\
  16  CLUSTAL format. It returns the mfe structure in bracket notation, its\
  17  energy, the free energy of the thermodynamic ensemble and the frequency of\
  18  the mfe structure in the ensemble to stdout.  It also produces Postscript\
  19  files with plots of the resulting secondary structure graph (\"alirna.ps\")\
  20  and a \"dot plot\" of the base pairing matrix (\"alidot.ps\"). The file\
  21  \"alifold.out\" will contain a list of likely pairs sorted by credibility,\
  22  suitable for viewing  with \"AliDot.pl\". Be warned that output file will\
  23  overwrite any existing files of the same name.\n\n"
  24
  25 # Options
  26
  27 section "General Options"
  28 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  29
  30 option  "constraint"  C
  31 "Calculate structures subject to constraints.\nThe constraining structure will be read from 'stdin',\
  32  the alignment has to be given as a file name on the command line.\n"
  33 details="The program reads first the\
  34  sequence, then a string containing constraints on the structure encoded with the symbols:\n\n. (no constraint\
  35  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\
  36  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\
  37  exception of \"|\", constraints will disallow all pairs conflicting with the constraint. This is usually\
  38  sufficient to enforce the constraint, but occasionally a base may stay unpaired in spite of constraints. PF\
  39  folding ignores constraints of type \"|\".\n\n"
  40 flag
  41 off
  42
  43 option  "color"   -
  44 "Produce a colored version of the consensus strcture plot \"alirna.ps\" (default b&w only)\n\n"
  45 flag
  46 off
  47
  48 option  "aln"             -
  49 "Produce a colored and structure annotated alignment in PostScript format in the file \"aln.ps\" in the\
  50  current directory.\n\n"
  51 flag
  52 off
  53
  54 option "noPS"   -
  55 "Do not produce postscript output\n\n"
  56 flag
  57 off
  58
  59
  60 section "Algorithms"
  61 sectiondesc="Select additional algorithms which should be included in the calculations.\nThe Minimum free energy\
  62  (MFE) and a structure representative are calculated in any case.\n\n"
  63
  64 option  "partfunc"        p
  65 "Calculate the partition function and base pairing probability matrix in\
  66  addition to the mfe structure. Default is calculation of mfe structure only.\n"
  67 details="In addition to the MFE structure we print a coarse representation of the pair probabilities in form\
  68  of a pseudo bracket notation, followed by the ensemble free energy, as well as the centroid structure derived\
  69  from the pair probabilities together with its free energy and distance to the ensemble. Finally it prints the\
  70  frequency of the mfe structure.\n\nAn additionally passed value to this option changes the behavior of\
  71  partition function calculation:\n-p0 deactivates the calculation of the pair probabilities,\
  72  saving about 50% in runtime. This prints the ensemble free energy -kT ln(Z).\n\n"
  73 int
  74 default="1"
  75 argoptional
  76 optional
  77
  78 option  "MEA"   -
  79 "Calculate an MEA (maximum expected accuracy) structure.\n"
  80 details="If gamma is not specified a default of gamma=1 is used.\nUsing --MEA implies -p\nSee also RNAfold man page for details.\n\n"
  81 float
  82 typestr="gamma"
  83 default="1."
  84 argoptional
  85 optional
  86
  87 option  "mis"             -
  88 "Output \"most informative sequence\" instead of simple consensus: For each column of the alignment output\
  89  the set of nucleotides with frequence greater than average in IUPAC notation.\n\n"
  90 flag
  91 off
  92
  93 option  "stochBT"         s
  94 "Stochastic backtrack. Compute a certain number of random structures with a probability dependend on the\
  95  partition function. See -p option in RNAsubopt.\n\n"
  96 int
  97 optional
  98
  99 option  "stochBT_en"      -
 100 "same as \"-s\" but also print out the energies and probabilities of the backtraced structures.\n\n"
 101 int
 102 optional
 103
 104 option  "pfScale" S
 105 "In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid\
 106  overflows).\n"
 107 details="The default is 1.07, useful values are 1.0 to 1.2. Occasionally needed\
 108  for long sequences.\nYou can also recompile the program to use double precision (see the README file).\n\n"
 109 double
 110 typestr="scaling factor"
 111 optional
 112 hidden
 113
 114 option  "circ"    c
 115 "Assume a circular (instead of linear) RNA molecule.\n\n"
 116 flag
 117 off
 118
 119 option  "bppmThreshold" -
 120 "Set the threshold for base pair probabilities included in the postscript output\n"
 121 details="By setting the threshold the base pair probabilities that are included in the\
 122  output can be varied. By default only those exceeding 1e-5 in probability will be shown as squares\
 123  in the dot plot. Changing the threshold to any other value allows for increase or decrease of data.\n\n"
 124 double
 125 typestr="<value>"
 126 optional
 127 default="1e-6"
 128 hidden
 129
 130 option  "gquad" g
 131 "Incoorporate G-Quadruplex formation into the structure prediction algorithm\n"
 132 flag
 133 off
 134
 135
 136 section "Model Details"
 137
 138 option  "temp"  T
 139 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
 140 double
 141 optional
 142
 143 option  "noTetra" 4
 144 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
 145 flag
 146 off
 147
 148 option  "dangles" d
 149 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
 150 details="\nWith -d2 dangling energies will be added for the bases adjacent to a helix on both sides
 151  in any case.\nThe option -d0 ignores dangling ends altogether (mostly for debugging).\n\n"
 152 int
 153 default="2"
 154 optional
 155
 156 option  "noLP"  -
 157 "Produce structures without lonely pairs (helices of length 1).\n"
 158 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
 159  pairs may still occasionally occur as helices of length 1.\n\n"
 160 flag
 161 off
 162
 163 option  "noGU"  -
 164 "Do not allow GU pairs\n\n"
 165 flag
 166 off
 167
 168 option  "noClosingGU" -
 169 "Do not allow GU pairs at the end of helices\n\n"
 170 flag
 171 off
 172
 173 option  "cfactor"         -
 174 "Set the weight of the covariance term in the energy function\n\n"
 175 default="1.0"
 176 double
 177 optional
 178
 179 option  "nfactor"         -
 180 "Set the penalty for non-compatible sequences in the covariance term of the energy function\n\n"
 181 default="1.0"
 182 double
 183 optional
 184
 185 option  "endgaps"         E
 186 "Score pairs with endgaps same as gap-gap pairs.\n\n"
 187 flag
 188 off
 189
 190 option  "ribosum_file"    R
 191 "use specified Ribosum Matrix instead of normal energy model. Matrixes to use should be 6x6 matrices,\
 192  the order of the terms is AU, CG, GC, GU, UA, UG.\n\n"
 193 string
 194 typestr="ribosumfile"
 195 optional
 196
 197 option  "ribosum_scoring" r
 198 "use ribosum scoring matrix. The matrix is chosen according to the minimal and maximal pairwise\
 199  identities of the sequences in the file.\n\n"
 200 flag
 201 off
 202
 203 option  "old" -
 204 "use old energy evaluation, treating gaps as characters.\n\n"
 205 flag
 206 off
 207
 208 option  "paramFile" P
 209 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
 210 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
 211  documentation for details on the file format.\n\n"
 212 string
 213 typestr="paramfile"
 214 optional
 215
 216 option  "nsp" -
 217 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 218 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 219  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 220  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 221  energy.\n\n"
 222 string
 223 optional
 224 hidden
 225
 226 option  "energyModel" e
 227 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 228  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 229 int
 230 optional
 231 hidden
 232
 233 option  "betaScale" -
 234 "Set the scaling of the Boltzmann factors\n"
 235 details="The argument provided with this option enables to scale the thermodynamic temperature\
 236  used in the Boltzmann factors independently from the temperature used to scale the individual\
 237  energy contributions of the loop types. The Boltzmann factors then become exp(-dG/(kTn*betaScale))\
 238  where k is the Boltzmann constant, dG the free energy contribution of the state, T the\
 239  absolute temperature and n the number of sequences.\n\n"
 240 double
 241 default="1."
 242 optional
 243 dependon="partfunc"
 244 hidden
 245
 246
 247
 248 text  "Caveats:\n\nSequences are not weighted. If possible, do not mix very similar and\
 249  dissimilar sequences. Duplicate sequences, for example, can distort the prediction.\n\n"
 250
 251 text  "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 252  rna@tbi.univie.ac.at.\n"