binaries/src/ViennaRNA/Progs/RNAsnoop.ggo

   1 # Name of your program
   2 package "RNAsnoop" # don't use package if you're using automake
   3 purpose "Find targets of a query H/ACA snoRNA"
   4 usage "RNAsnoop [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=RNAsnoop_cmdl --include-getopt --default-optional --func-name=RNAsnoop_cmdline_parser --arg-struct-name=RNAsnoop_args_info"
  12
  13
  14 description "reads a target RNA sequence and a H/ACA snoRNA sequence
  15 from a target and query file, respectively and computes optimal
  16 and suboptimal secondary structures for their hybridization. The
  17 calculation can be done roughly done in O(nm), where is n the length
  18 of the target sequence and m is the length of the snoRNA stem, as it
  19 is specially tailored to the special case of H/ACA snoRNA. For general
  20 purpose target predictions, please have a look at RNAduplex, RNAup,
  21 RNAcofold and RNAplex. Accessibility effects can be estimated by
  22 RNAsnoop if a RNAplfold accessibility profile is provided. \n
  23 The computed optimal and suboptimal structure are written to
  24 stdout, one structure per line. Each line consist
  25 of: The structure in dot bracket format with a \"&\" separating the
  26 two strands. The '<>' brackets represent snoRNA intramolecular
  27 interactions, while the '()' brackets represent intermolecular
  28 interactions between the snoRNA and its target.
  29
  30 The range of the structure in the two sequences in the format
  31 \"from,to : from,to\"; the energy of duplex structure in
  32 kcal/mol. If available the opening energy are also returned.\n"
  33
  34 # Options
  35 section "Input Options"
  36 sectiondesc="Below are command line options which alter the general input behavior of RNAsnoop\n"
  37
  38
  39 option "alignmentLength" L
  40 "Limit the extent of the interactions to L nucleotides"
  41 int
  42 default="25"
  43 optional
  44
  45 option  "constraint"  C
  46 "Calculate the stem structure subject to constraints.\n"
  47 details="The program reads first the\
  48  stem sequence, then a string containing constraints on the structure encoded with the symbols:\n\n. (no constraint\
  49  for this base)\n\n| (the corresponding base has to be paired\n\nx (the base is unpaired)\n\n< (base i is paired with\
  50  a base j>i)\n\n> (base i is paired with a base j<i)\n\nand matching brackets ( ) (base i pairs base j)\n\nWith the\
  51  exception of \"|\", constraints will disallow all pairs conflicting with the constraint. This is usually\
  52  sufficient to enforce the constraint, but occasionally a base may stay unpaired in spite of constraints. PF\
  53  folding ignores constraints of type \"|\".\n\n"
  54 flag
  55 off
  56
  57
  58 option "query" s
  59 "File containing the query sequence.\n"
  60 details="Input sequences can be given piped to RNAsnoop or given in a query file with the -s option.\
  61  Note that the -s option implies that the -t option is also used\n\n"
  62 string
  63
  64 option "target" t
  65 "File containing the target sequence.\n"
  66 details="Input sequences can be given piped to RNAsnoop or given in a target file with the -t option\
  67 Note that the -t option implies that the -s option is also used\n\n"
  68 string
  69
  70 option "suffix" S
  71 "Specificy the suffix that was added by RNAup to the accessibility files\n\n"
  72 string
  73 default="_u1_to_30.out"
  74 optional
  75
  76 option "from-RNAplfold" P
  77 "Specify the directory where accessibility profile generated by RNAplfold are found\n\n"
  78 string
  79 optional
  80
  81 section "Algorithms"
  82 sectiondesc="Options which alter the computing behaviour of RNAplex.
  83 Please note that the options allowing to filter out snoRNA-RNA
  84 duplexes expect the energy to be given in decacal/mol instead of
  85 kcal/mol. A threshold of -2.8(kcal/mol) should be given as -280(decacal/mol)\n"
  86
  87 option "alignment-mode" A
  88 "Specify if RNAsnoop gets alignments or single sequences as input\n\n"
  89 flag
  90 off
  91
  92 option "fast-folding" f
  93 "Speedup of the target search"
  94 details="This option allows to decide if the backtracking has to be
  95 done (-f 1) or not (-f 0). For -f 1 the structure is computed based
  96 on the standard energy model. This is the slowest mode of RNAsnoop. -f
  97 0 is the fastest mode, as no structure are recomputed and only the
  98 interaction energy is returned\n\n"
  99 int
 100 default="1"
 101 optional
 102
 103 option "extension-cost" c
 104 "Cost to add to each nucleotide in a duplex"
 105 details="Cost of extending a duplex by one nucleotide. Allows to find
 106 compact duplexes, having few/small bulges or interior loops. Only
 107 useful when no accessibility profiles are available. This option is
 108 disabled if accessibility profiles are used (-P option)\n\n"
 109 int
 110 default="0"
 111 optional
 112
 113 option "minimal-right-duplex" o
 114 "Minimal Right Duplex Energy\n\n"
 115 default="-270"
 116 int
 117 optional
 118
 119 option "minimal-loop-energy" l
 120 "Minimal Right Duplex Energy\n"
 121 details="Minimal Stem Loop Energy of the snoRNA. The energy should be
 122 given in decacalories, i.e. a minimal stem-loop energy of -2.8
 123 kcal/mol corresponds to -280 decacal/mol\n\n"
 124 default="-280"
 125 int
 126 optional
 127
 128 option "minimal-left-duplex" p
 129 "Minimal Left Duplex Energy\n\n"
 130 default="-170"
 131 int
 132 optional
 133
 134 option "minimal-duplex" q
 135 "Minimal Duplex Energy\n\n"
 136 default="-1090"
 137 int
 138 optional
 139
 140 option "duplex-distance" d
 141 "Distance between target 3' ends of two consecutive duplexes\n"
 142 details="Distance between the target 3'ends of two consecutive
 143 duplexes. Should be set to the maximal length of interaction to get
 144 good results. Smaller d leads to larger overlaps between consecutive
 145 duplexes\n\n"
 146 int
 147 default="2"
 148 optional
 149
 150 option "minimal-stem-length" h
 151 "Minimal snoRNA stem length\n\n"
 152 default="5"
 153 int
 154 optional
 155
 156 option "maximal-stem-length" i
 157 "Maximal snoRNA stem length\n\n"
 158 default="120"
 159 int
 160 optional
 161
 162 option "minimal-duplex-box-length" j
 163 "Minimal distance between the duplex end and the H/ACA box\n\n"
 164 default="11"
 165 int
 166 optional
 167
 168 option "maximal-duplex-box-length" k
 169 "Maximal distance between the duplex end and the H/ACA box\n\n"
 170 default="16"
 171 int
 172 optional
 173
 174 option "minimal-snoRNA-stem-loop-length" m
 175 "Minimal number of nucleotides between the beginning of stem loop and
 176 beginning of the snoRNA sequence\n\n"
 177 default="1"
 178 int
 179 optional
 180
 181 option "maximal-snoRNA-stem-loop-length" n
 182 "Maximal number of nucleotides between the beginning of stem loop and
 183 beginning of the snoRNA sequence\n\n"
 184 default="100000"
 185 int
 186 optional
 187
 188 option "minimal-snoRNA-duplex-length" v
 189 "Minimal distance between duplex start and snoRNA\n\n"
 190 int
 191 default="0"
 192 optional
 193
 194 option "maximal-snoRNA-duplex-length" w
 195 "Maximal distance between duplex start and snoRNA\n\n"
 196 int
 197 default="0"
 198 optional
 199
 200 option "minimal-duplex-stem-energy" x
 201 "Minimal duplex stem energy\n\n"
 202 int
 203 default="-1370"
 204 optional
 205
 206 option "minimal-total-energy" y
 207 "Minimal total energy\n\n"
 208 int
 209 default="100000"
 210 optional
 211
 212 option "maximal-stem-asymmetry" a
 213 "Maximal snoRNA stem asymmetry\n\n"
 214 int
 215 default="30"
 216 optional
 217
 218 option "minimal-lower-stem-energy" b
 219 "Minimal lower stem energy\n\n"
 220 int
 221 default="100000"
 222 optional
 223
 224 section "Output options"
 225 sectiondesc="Options that modifies the output\n\n"
 226
 227 option "energy-threshold" e
 228 "Maximal energy difference between the mfe and the desired suboptimal\n"
 229 details="Energy range for a duplex to be returned. The threshold is set on the total energy of interaction, i.e. the hybridization\
 230 energy corrected for opening energy if -a is set or the energy corrected by -c. If unset, only the mfe will be returned\n\n"
 231 double
 232 default="-1"
 233 optional
 234
 235 option "produce-ps" I
 236 "Draw annotated 2D structures for a list of dot-bracket structures\n"
 237 details="This option allows to produce interaction figures in PS-format with conservation/accessibility annotation, if available\n\n"
 238 flag
 239 off
 240
 241 option  "output_directory"  O
 242 "Set where the generated figures should be stored\n\n"
 243 string
 244 default="./"
 245 optional
 246
 247 option "direct-redraw" N
 248 "Outputs 2D interactions concurrently with the interaction calculation for each suboptimal interaction. The -I option should be preferred.\n\n"
 249 flag
 250 off
 251
 252 option "from-RNAup" U
 253 "Specify the directory where accessibility profiles generated by RNAup are found\n\n"
 254 string
 255 optional
 256
 257
 258
 259
 260
 261 text    "\nIf in doubt our program is right, nature is at fault.\nComments should be sent to\
 262  rna@tbi.univie.ac.at.\n"