binaries/src/ViennaRNA/Progs/RNALalifold.ggo

   1 # Name of your program
   2 package "RNALalifold" # don't use package if you're using automake
   3 purpose "calculate locally stable secondary structures for a set of aligned RNAs"
   4 usage   "RNALalifold [options] <file1.aln>"
   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=RNALalifold_cmdl --include-getopt --default-optional --unamed-opts --func-name=RNALalifold_cmdline_parser --arg-struct-name=RNALalifold_args_info"
  12
  13 description "reads aligned RNA sequences from stdin or file.aln and calculates\
  14  locally stable RNA secondary structure with a maximal base pair span. For a sequence\
  15  of length n and a base pair span of L the algorithm uses only O(n+L*L) memory and\
  16  O(n*L*L) CPU time. Thus it is practical to \"scan\" very large genomes for short RNA
  17  structures.\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  "span"  L
  24 "Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with\
  25  j-i>span will be allowed.\n\n"
  26 int
  27 default="70"
  28 optional
  29
  30 option  "csv"   -
  31 "Create comma seperated output (csv)\n\n"
  32 flag
  33 off
  34
  35 section "Algorithms"
  36 sectiondesc="Select additional algorithms which should be included in the calculations.\nThe Minimum free energy\
  37  (MFE) and a structure representative are calculated in any case.\n\n"
  38
  39 option  "partfunc"  p
  40 "Calculate the partition function and base pairing probability matrix in addition to the mfe structure."
  41 details="Default is calculation of mfe structure only. In addition to the MFE structure we print a coarse\
  42  representation of the pair probabilities in form of a pseudo bracket notation, followed by the ensemble\
  43  free energy, as well as the centroid structure derived from the pair probabilities together with\
  44  its free energy and distance to the ensemble. Finally it prints the frequency of the mfe structure.\n\nAn\
  45  additionally passed value to this option changes the behavior of partition function calculation:\n-p0\
  46  \tCalculate the partition function but not the pair probabilities, saving about 50% in runtime. This\
  47  prints the ensemble free energy -kT ln(Z).\n\n"
  48 int
  49 default="1"
  50 argoptional
  51 optional
  52
  53 option  "cutoff"  c
  54 "Report only base pairs with an average probability > cutoff in the dot plot\n\n"
  55 float
  56 default="0.01"
  57 optional
  58
  59 option  "pfScale" S
  60 "In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid\
  61  overflows).\n"
  62 details="The default is 1.07, useful values are 1.0 to 1.2. Occasionally needed\
  63  for long sequences.\nYou can also recompile the program to use double precision (see the README file).\n\n"
  64 double
  65 typestr="scaling factor"
  66 optional
  67 hidden
  68
  69 option  "mis" -
  70 "Output \"most informative sequence\" instead of simple consensus: For each column of the alignment\
  71  output the set of nucleotides with frequence greater than average in IUPAC notation.\n\n"
  72 flag
  73 off
  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 optional
  81
  82 option  "noTetra" 4
  83 "Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.\n\n"
  84 flag
  85 off
  86
  87 option  "dangles" d
  88 "How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops\n"
  89 details="\nWith -d1 only unpaired bases can participate in at most one dangling end, this is unsupported\
  90  for the partition function folding.\n\nWith -d2 this check is ignored,\
  91  dangling energies will be added for the bases adjacent to a helix on both sides in any case; this is the\
  92  default for partition function folding (-p).\nThe option -d0 ignores dangling ends altogether (mostly for\
  93  debugging).\nWith -d3 mfe folding will allow coaxial stacking of adjacent helices in multi-loops. At the\
  94  moment the implementation will not allow coaxial stacking of the two interior pairs in a loop of degree 3\
  95  and works only for mfe folding.\n\nNote that by default (as well as with -d1 and -d3) pf and mfe folding\
  96  treat dangling ends differently. Use -d2 in addition to -p to ensure that both algorithms use the same\
  97  energy model.\n\n"
  98 int
  99 default="2"
 100 optional
 101
 102 option  "noLP"  -
 103 "Produce structures without lonely pairs (helices of length 1).\n"
 104 details="For partition function folding this only disallows pairs that can only occur isolated. Other\
 105  pairs may still occasionally occur as helices of length 1.\n\n"
 106 flag
 107 off
 108
 109 option  "noGU"  -
 110 "Do not allow GU pairs\n\n"
 111 flag
 112 off
 113
 114 option  "noClosingGU" -
 115 "Do not allow GU pairs at the end of helices\n\n"
 116 flag
 117 off
 118
 119 option  "paramFile" P
 120 "Read energy parameters from paramfile, instead of using the default parameter set.\n"
 121 details="A sample parameter file should accompany your distribution.\nSee the RNAlib\
 122  documentation for details on the file format.\n\n"
 123 string
 124 typestr="paramfile"
 125 optional
 126
 127 option  "nsp" -
 128 "Allow other pairs in addition to the usual AU,GC,and GU pairs.\n"
 129 details="Its argument is a comma separated list of additionally allowed pairs. If the\
 130  first character is a \"-\" then AB will imply that AB and BA are allowed pairs.\ne.g.\
 131  RNAfold -nsp -GA  will allow GA and AG pairs. Nonstandard pairs are given 0 stacking\
 132  energy.\n\n"
 133 string
 134 optional
 135 hidden
 136
 137 option  "energyModel" e
 138 "Rarely used option to fold sequences from the artificial ABCD... alphabet, where\
 139  A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.\n\n"
 140 int
 141 optional
 142 hidden
 143
 144 option  "cfactor" -
 145 "Set the weight of the covariance term in the energy function\n\n"
 146 default="1.0"
 147 double
 148 optional
 149
 150 option  "nfactor" -
 151 "Set the penalty for non-compatible sequences in the covariance term of the energy function\n\n"
 152 default="1.0"
 153 double
 154 optional
 155
 156 option  "ribosum_file"    R
 157 "use specified Ribosum Matrix instead of normal energy model. Matrixes to use should be 6x6 matrices,\
 158  the order of the terms is AU, CG, GC, GU, UA, UG.\n\n"
 159 string
 160 typestr="ribosumfile"
 161 optional
 162
 163 option  "ribosum_scoring" r
 164 "use ribosum scoring matrix. The matrix is chosen according to the minimal and maximal pairwise\
 165  identities of the sequences in the file.\n\n"
 166 flag
 167 off
 168
 169
 170 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 171  rna@tbi.univie.ac.at.\n"