binaries/src/ViennaRNA/Progs/RNAeval.ggo

   1 # Name of your program
   2 package "RNAeval" # don't use package if you're using automake
   3 purpose "calculate energy of RNA sequences with given secondary structure"
   4 #usage "RNAeval [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=RNAeval_cmdl --include-getopt --default-optional --func-name=RNAeval_cmdline_parser --arg-struct-name=RNAeval_args_info"
  12
  13
  14 description "Evaluates the free energy of an RNA molecule in fixed secondary structure.\
  15  Sequences and structures are read alternately from stdin. The energy in Kcal/Mol is written\
  16  to stdout.\nThe program will continue to read new sequences and structures until a line\
  17  consisting of the single character \"@\" or an end of file condition is encountered.\nIf\
  18  the input sequence or structure contains the separator character \"&\" the program calculates\
  19  the energy of the co-folding of two RNA strands, where the \"&\" marks the boundary between\
  20  the two strands.\n"
  21
  22 # Options
  23 section "General Options"
  24 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  25
  26 option  "noconv"  -
  27 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  28 flag
  29 off
  30
  31 option "verbose" v
  32 "Print out energy contribution of each loop in the structure.\n\n"
  33 flag
  34 off
  35
  36 section "Model Details"
  37
  38 option  "temp"  T
  39 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
  40 double
  41
  42 option  "noTetra" 4
  43 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  44 flag
  45 off
  46
  47 option  "dangles" d
  48 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
  49 details="\nWith -d1 only unpaired bases can participate in at most one dangling end, this unsupported for the\
  50  partition function folding.\n\nWith -d2 this check is ignored,\
  51  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
  52  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
  53  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
  54  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3.\n"
  55 int
  56 default="2"
  57 optional
  58
  59 option  "energyModel" e
  60 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
  61  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
  62 int
  63 optional
  64
  65 option  "paramFile" P
  66 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
  67 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
  68  documentation for details on the file format.\n\n"
  69 string
  70 typestr="paramfile"
  71 optional
  72
  73 option  "circ" c
  74 "Assume a circular (instead of linear) RNA molecule.\n\n"
  75 flag
  76 off
  77
  78 option  "gquad" g
  79 "Incoorporate G-Quadruplex formation into the structure prediction algorithm\n"
  80 flag
  81 off
  82
  83 option  "logML" -
  84 "Recalculate energies of structures using a logarithmic energy function for multi-loops before output.\n"
  85 details="This option does not effect structure generation, only the energies that are printed out.\
  86  Since logML lowers energies somewhat, some structures may be missing.\n\n"
  87 flag
  88 off
  89
  90 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
  91  rna@tbi.univie.ac.at.\n"