binaries/src/ViennaRNA/Progs/RNAheat.ggo

   1 # Name of your program
   2 package "RNAheat" # don't use package if you're using automake
   3 purpose "calculate specific heat of RNAs"
   4 usage "RNAheat [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=RNAheat_cmdl --include-getopt --default-optional --func-name=RNAheat_cmdline_parser --arg-struct-name=RNAheat_args_info"
  12
  13
  14 description "Reads RNA sequences from stdin and calculates their specific heat in the temperature range t1\
  15  to t2, from the partition function by numeric differentiation. The result is written to stdout as a list\
  16  of pairs of temperature in C and specific heat in Kcal/(Mol*K).\nThe program will continue to read new\
  17  sequences until a line consisting of the single character \"@\" or an end of file condition is encountered.\n"
  18
  19 # Options
  20 section "General Options"
  21 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  22
  23 option  "Tmin"  -
  24 "Lowest temperature\n\n"
  25 float
  26 default = "0"
  27 typestr="t1"
  28
  29 option  "Tmax"  -
  30 "Highest temperature\n\n"
  31 float
  32 default = "100"
  33 typestr="t2"
  34
  35 option "stepsize" -
  36 "Calculate partition function every stepsize degrees C\n\n"
  37 float
  38 default="1."
  39
  40 option "ipoints" m
  41 "The program fits a parabola to 2*ipoints+1 data points to calculate 2nd derivatives. Increasing this parameter\
  42  produces a smoother curve\n\n"
  43 int
  44 typestr="ipoints"
  45 default="2"
  46
  47 option  "noconv"  -
  48 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  49 flag
  50 off
  51
  52 section "Model Details"
  53
  54 option  "noTetra" 4
  55 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  56 flag
  57 off
  58
  59 option  "dangles" d
  60 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
  61 details="\nWith -d2 dangling energies will be added for the bases adjacent to a helix on both sides\
  62  in any case\n\n-d0 ignores dangling ends altogether (mostly for debugging).\n\n"
  63 int
  64 default="2"
  65 optional
  66
  67 option  "noLP"  -
  68 "Produce structures without lonely pairs (helices of length 1).\n"
  69 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
  70  pairs may still occasionally occur as helices of length 1.\n\n"
  71 flag
  72 off
  73
  74 option  "noGU"  -
  75 "Do not allow GU pairs\n"
  76 flag
  77 off
  78
  79 option  "noClosingGU" -
  80 "Do not allow GU pairs at the end of helices\n\n"
  81 flag
  82 off
  83
  84 option  "paramFile" P
  85 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
  86 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
  87  documentation for details on the file format.\n\n"
  88 string
  89 typestr="paramfile"
  90 optional
  91
  92 option  "nsp" -
  93 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
  94 details="Its argument is a comma separated list of additionally allowed pairs. If the\
  95  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
  96  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
  97  energy.\n\n"
  98 string
  99 optional
 100 hidden
 101
 102 option  "energyModel" e
 103 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 104  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 105 int
 106 optional
 107 hidden
 108
 109
 110 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 111  rna@tbi.univie.ac.at.\n"