binaries/src/ViennaRNA/Progs/RNALfold.ggo

   1 # Name of your program
   2 package "RNALfold" # don't use package if you're using automake
   3 purpose "calculate locally stable secondary structures of RNAs"
   4 #usage "RNALfold [options]\n"
   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=RNALfold_cmdl --include-getopt --default-optional --func-name=RNALfold_cmdline_parser --arg-struct-name=RNALfold_args_info"
  12
  13
  14 description "Compute locally stable RNA secondary structure with a maximal base pair\
  15  span. For a sequence of length n and a base pair span of L the algorithm uses only\
  16  O(n+L*L) memory and O(n*L*L) CPU time. Thus it is practical to \"scan\" very large\
  17  genomes for short RNA structures.\nOutput consists of a list of secondary structure\
  18  components of size <= L, one entry per line. Each output line contains the predicted\
  19  local structure its energy in kcal/mol and the starting position of the local structure.\n"
  20
  21 # Options
  22
  23 section "General Options"
  24 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  25
  26 option  "span"  L
  27 "Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with\
  28  j-i>span will be allowed.\n\n"
  29 int
  30 default="150"
  31 optional
  32
  33 option  "noconv"  -
  34 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  35 flag
  36 off
  37
  38 section "Algorithms"
  39 sectiondesc="Select additional algorithms which should be included in the calculations.\nThe Minimum free energy\
  40  (MFE) and a structure representative are calculated in any case.\n\n"
  41
  42 option  "zscore"  z
  43 "Activate z-score computation. An optional argument may be supplied to set the threshold\nDue to parsing the\
  44  commandline parameters a negative value should be given immediately after \"z\" without spaces e.g. -z-4.9\n\n"
  45 double
  46 default="-2"
  47 argoptional
  48 optional
  49
  50 option  "gquad" g
  51 "Incoorporate G-Quadruplex formation into the structure prediction algorithm\n"
  52 flag
  53 off
  54
  55
  56 section "Model Details"
  57
  58 option  "temp"  T
  59 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
  60 double
  61 optional
  62
  63 option  "noTetra" 4
  64 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  65 flag
  66 off
  67
  68 option  "dangles" d
  69 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
  70 details="\nWith -d1 only unpaired bases can participate in at most one dangling end, this is the\
  71  default for mfe folding but unsupported for the partition function folding.\n\nWith -d2 this check is ignored,\
  72  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
  73  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
  74  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
  75  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3\
  76  and works only for mfe folding.\n\nNote that by default (as well as with -d1 and -d3) pf and mfe folding\
  77  treat dangling ends differently. Use -d2 in addition to -p to ensure that both algorithms use the same\
  78  energy model.\n\n"
  79 int
  80 default="2"
  81 optional
  82
  83 option  "noLP"  -
  84 "Produce structures without lonely pairs (helices of length 1).\n"
  85 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
  86  pairs may still occasionally occur as helices of length 1.\n\n"
  87 flag
  88 off
  89
  90 option  "noGU"  -
  91 "Do not allow GU pairs\n\n"
  92 flag
  93 off
  94
  95 option  "noClosingGU" -
  96 "Do not allow GU pairs at the end of helices\n\n"
  97 flag
  98 off
  99
 100 option  "paramFile" P
 101 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
 102 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
 103  documentation for details on the file format.\n\n"
 104 string
 105 typestr="paramfile"
 106 optional
 107
 108 option  "nsp" -
 109 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 110 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 111  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 112  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 113  energy.\n\n"
 114 string
 115 optional
 116 hidden
 117
 118 option  "energyModel" e
 119 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 120  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 121 int
 122 optional
 123 hidden
 124
 125 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 126  rna@tbi.univie.ac.at.\n"