binaries/src/ViennaRNA/Progs/RNAduplex.ggo

   1 # Name of your program
   2 package "RNAduplex" # don't use package if you're using automake
   3 purpose "Compute the structure upon hybridization of two RNA strands"
   4 #usage "RNAduplex [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=RNAduplex_cmdl --include-getopt --default-optional --func-name=RNAduplex_cmdline_parser --arg-struct-name=RNAduplex_args_info"
  12
  13
  14 description "reads two RNA sequences from stdin or <filename> and computes optimal\
  15  and suboptimal secondary structures for their hybridization. The calculation is simplified\
  16  by allowing only inter-molecular base pairs, for the general case use RNAcofold.\nThe computed\
  17  optimal and suboptimal structure are written to stdout, one structure per line. Each line consist\
  18  of: The structure in dot bracket format with a \"&\" separating the two strands. The range of the\
  19  structure in the two sequences in the format  \"from,to : from,to\"; the energy of duplex structure\
  20  in kcal/mol.\nThe format is especially useful for computing the hybrid structure between a small\
  21  probe sequence and a long target sequence.\n"
  22
  23 # Options
  24 section "General Options"
  25 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  26
  27 option  "sorted"  s
  28 "sort the printed output by free energy\n\n"
  29 flag
  30 off
  31
  32 option  "noconv"  -
  33 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  34 flag
  35 off
  36
  37 section "Algorithms"
  38 sectiondesc="Select additional algorithms which should be included in the calculations.\n"
  39
  40 option  "deltaEnergy" e
  41 "Compute suboptimal structures with energy in a certain range of the optimum (kcal/mol).\
  42  Default is calculation of mfe structure only.\n\n"
  43 float
  44 typestr="range"
  45 optional
  46
  47 section "Model Details"
  48
  49 option  "temp"  T
  50 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
  51 double
  52 optional
  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 -d1 only unpaired bases can participate in at most one dangling end, this is the\
  62  default for mfe folding but unsupported for the partition function folding.\n\nWith -d2 this check is ignored,\
  63  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
  64  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
  65  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
  66  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3\
  67  and works only for mfe folding.\n\nNote that by default (as well as with -d1 and -d3) pf and mfe folding\
  68  treat dangling ends differently. Use -d2 in addition to -p to ensure that both algorithms use the same\
  69  energy model.\n\n"
  70 int
  71 default="2"
  72 optional
  73
  74 option  "noLP"  -
  75 "Produce structures without lonely pairs (helices of length 1).\n"
  76 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
  77  pairs may still occasionally occur as helices of length 1.\n\n"
  78 flag
  79 off
  80
  81 option  "noGU"  -
  82 "Do not allow GU pairs\n\n"
  83 flag
  84 off
  85
  86 option  "noClosingGU" -
  87 "Do not allow GU pairs at the end of helices\n\n"
  88 flag
  89 off
  90
  91 option  "paramFile" P
  92 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
  93 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
  94  documentation for details on the file format.\n\n"
  95 string
  96 typestr="paramfile"
  97 optional
  98
  99 option  "nsp" -
 100 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 101 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 102  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 103  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 104  energy.\n\n"
 105 string
 106 optional
 107 hidden
 108
 109 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 110  rna@tbi.univie.ac.at.\n"