binaries/src/ViennaRNA/Progs/RNA2Dfold.ggo

   1 # Name of your program
   2 package "RNA2Dfold" # don't use package if you're using automake
   3 purpose "Compute MFE structure, partition function and representative sample structures of k,l neighborhoods"
   4
   5 # Version of your program
   6 #version "0.9"   # don't use version if you're using automake
   7
   8
   9 # command line options passed to gengetopt
  10 args "--file-name=RNA2Dfold_cmdl --include-getopt --default-optional --func-name=RNA2Dfold_cmdline_parser --arg-struct-name=RNA2Dfold_args_info"
  11
  12 description "The program partitions the secondary structure space into (basepair)distance classes according to\
  13  two fixed reference structures. It expects a sequence and two secondary structures in dot-bracket notation as\
  14  its inputs. For each distance class, the MFE representative, Boltzmann probabilities and Gibbs free energy is\
  15  computed. Additionally, a stochastic backtracking routine allows to produce samples of representative suboptimal\
  16  secondary structures from each partition\n\n"
  17
  18
  19 # Options
  20 section "General Options"
  21 sectiondesc="Below are command line options which alter the general behavior of this program\n\n"
  22
  23 option  "noconv"  -
  24 "Do not automatically substitude nucleotide \"T\" with \"U\"\n\n"
  25 flag
  26 off
  27
  28 option  "numThreads"  j
  29 "Set the number of threads used for calculations (only available when compiled with OpenMP support)\n\n"
  30 int
  31 optional
  32
  33 section "Algorithms"
  34
  35 option  "partfunc"  p
  36 "calculate partition function and thus, Boltzmann probabilities and Gibbs free energy\n\n"
  37 flag
  38 off
  39
  40
  41 option  "stochBT" -
  42 "backtrack a certain number of Boltzmann samples from the appropriate k,l neighborhood(s)\n\n"
  43 int
  44 optional
  45
  46 option  "neighborhood"  -
  47 "backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)\n\n"
  48 string
  49 typestr="<k>:<l>"
  50 multiple
  51 dependon="stochBT"
  52
  53 option  "pfScale" S
  54 "scaling factor for pf to avoid overflows\n\n"
  55 double
  56 optional
  57
  58 option  "noBT"  -
  59 "do not backtrack structures, calculate energy contributions only\n\n"
  60 flag
  61 off
  62
  63 option  "circ"  c
  64 "Assume a circular (instead of linear) RNA molecule.\n\n"
  65 flag
  66 off
  67
  68 section "Model Details"
  69
  70 option  "temp"  T
  71 "Rescale energy parameters to a temperature of temp C. Default is 37C.\n\n"
  72 double
  73 optional
  74
  75 option  "maxDist1"  K
  76 "maximum distance to first reference structure"
  77 details="If this value is set all structures that exhibit a basepair distance greater than maxDist1 will\
  78  be thrown into a distance class denoted by K=L=-1\n\n"
  79 int
  80 optional
  81
  82 option  "maxDist2"  L
  83 "maximum distance to second reference structure"
  84 details="If this value is set all structures that exhibit a basepair distance greater than maxDist1 will\
  85  be thrown into a distance class denoted by K=L=-1\n\n"
  86 int
  87
  88 option  "noTetra" 4
  89 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  90 flag
  91 off
  92
  93 option  "parameterFile" P
  94 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
  95 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
  96  documentation for details on the file format.\n\n"
  97 string
  98 typestr="paramfile"
  99
 100 option  "dangles" d
 101 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
 102 details="\nWith -d2 dangling energies will be added for the bases adjacent to a helix on both sides
 103  in any case.\nThe option -d0 ignores dangling ends altogether (mostly for debugging).\n\n"
 104 int
 105 default="2"
 106 values="0","2"
 107
 108 option  "noGU"  -
 109 "Do not allow GU pairs\n\n"
 110 flag
 111 off
 112
 113 option  "noClosingGU" -
 114 "Do not allow GU pairs at the end of helices\n\n"
 115 flag
 116 off
 117
 118 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 119  rna@tbi.univie.ac.at.\n\n"