binaries/src/ViennaRNA/Progs/RNAinverse.ggo

   1 # Name of your program
   2 package "RNAinverse" # don't use package if you're using automake
   3
   4 purpose "Find RNA sequences with given secondary structure"
   5
   6 #usage "RNAinverse [options]\n"
   7
   8 # Version of your program
   9 #version "2.0"   # don't use version if you're using automake
  10
  11
  12 # command line options passed to gengetopt
  13 args "--file-name=RNAinverse_cmdl --include-getopt --default-optional --func-name=RNAinverse_cmdline_parser --arg-struct-name=RNAinverse_args_info"
  14
  15
  16 description "The program searches for sequences folding into a predefined structure, thereby\
  17  inverting the folding algorithm. Target structures (in bracket notation) and starting sequences\
  18  for the search are read alternately from stdin.\nCharacters in the start sequence other than \"AUGC\"\
  19  (or the alphabet specified with -a) will be treated as wild cards and replaced by a random character.\
  20  Any lower case characters in the start sequence will be kept fixed during the search. If necessary,\
  21  the sequence will be elongated to the length of the structure. Thus a string of \"N\"s as well as a\
  22  blank line specify a random start sequence.\nFor each search the best sequence found and its Hamming\
  23  distance to the start sequence are printed to stdout. If the the search was unsuccessful, a structure\
  24  distance to the target is appended.\nThe -Fp and -R options can modify the output format, see commandline\
  25  options below.\nThe program will continue to read new structures and sequences until a line consisting\
  26  of the single character \"@\" or an end of file condition is encountered.\n"
  27
  28 # Options
  29 section "General Options"
  30 sectiondesc="Below are command line options which alter the general behavior of this program\n"
  31
  32 option  "repeat"   R
  33 "Search repeatedly for the same structure.\nIf an argument is supplied to this option it must\
  34  follow the option flag immediately. E.g.: -R5\n"
  35 details="If repeats is negative search until --repeats exact solutions are found, no\
  36  output is done for unsuccessful searches. Be aware, that the program will not terminate\
  37  if the target structure can not be found.\nIf no value is supplied with this option, the\
  38  default value is used.\n\n"
  39 int
  40 argoptional
  41 default="100"
  42 optional
  43
  44 option  "alphabet"    a
  45 "Find sequences using only nucleotides from a given alphabet.\n\n"
  46 string
  47 typestr="ALPHABET"
  48 optional
  49
  50 option  "verbose"   v
  51 "In conjunction with a negative value supplied to -R, print the last subsequence and\
  52  substructure for each unsuccessful search.\n\n"
  53 flag
  54 off
  55
  56 section "Algorithms"
  57 sectiondesc="Select additional algorithms which should be included in the calculations.\n\n"
  58
  59 option  "function"  F
  60 "Use minimum energy (-Fm), partition function folding (-Fp) or both (-Fmp).\n"
  61 details="In partition function mode, the probability of the target structure exp(-E(S)/kT)/Q is maximized.\
  62  This probability is written in brackets after the found sequence and Hamming distance. In most cases\
  63  you'll want to use the -f option in conjunction with -Fp, see below.\n\n"
  64 string
  65 typestr="mp"
  66 default="m"
  67 optional
  68
  69 option  "final"   f
  70 "In combination with -Fp stop search when sequence is found with E(s)-F is smaller\
  71  than final, where F=-kT*ln(Q).\n\n"
  72 float
  73 optional
  74
  75 section "Model Details"
  76
  77 option  "temp"  T
  78 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
  79 double
  80
  81 option  "noTetra" 4
  82 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  83 flag
  84 off
  85
  86 option  "dangles" d
  87 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
  88 details="\nWith -d1 only unpaired bases can participate in at most one dangling end, this is unsupported\
  89  for the partition function folding.\n\nWith -d2 this check is ignored,\
  90  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
  91  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
  92  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
  93  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3\
  94  and works only for mfe folding.\n\nNote that by default (as well as with -d1 and -d3) pf and mfe folding\
  95  treat dangling ends differently. Use -d2 in addition to -Fp to ensure that both algorithms use the same\
  96  energy model.\n\n"
  97 int
  98 default="2"
  99 optional
 100
 101 option  "noGU"  -
 102 "Do not allow GU pairs\n\n"
 103 flag
 104 off
 105
 106 option  "noClosingGU" -
 107 "Do not allow GU pairs at the end of helices\n\n"
 108 flag
 109 off
 110
 111 option  "paramFile" P
 112 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
 113 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
 114  documentation for details on the file format.\n\n"
 115 string
 116 typestr="paramfile"
 117 optional
 118
 119 option  "nsp" -
 120 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 121 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 122  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 123  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 124  energy.\n\n"
 125 string
 126 optional
 127 hidden
 128
 129 option  "energyModel" e
 130 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 131  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 132 int
 133 optional
 134 hidden
 135
 136 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 137  rna@tbi.univie.ac.at.\n"