binaries/src/ViennaRNA/man/RNAsnoop.1

   1 2.1.2
   2
   3 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
   4 .TH RNASNOOP "1" "July 2013" "RNAsnoop 2.1.2" "User Commands"
   5 .SH NAME
   6 RNAsnoop \- manual page for RNAsnoop 2.1.2
   7 .SH SYNOPSIS
   8 .B RNAsnoop
   9 [\fIoptions\fR]
  10 .SH DESCRIPTION
  11 RNAsnoop 2.1.2
  12 .PP
  13 Find targets of a query H/ACA snoRNA
  14 .PP
  15 reads a target RNA sequence and a H/ACA snoRNA sequence
  16 from a target and query file, respectively and computes optimal
  17 and suboptimal secondary structures for their hybridization. The
  18 calculation can be done roughly done in O(nm), where is n the length
  19 of the target sequence and m is the length of the snoRNA stem, as it
  20 is specially tailored to the special case of H/ACA snoRNA. For general
  21 purpose target predictions, please have a look at RNAduplex, RNAup,
  22 RNAcofold and RNAplex. Accessibility effects can be estimated by
  23 RNAsnoop if a RNAplfold accessibility profile is provided.
  24 .PP
  25 The computed optimal and suboptimal structure are written to
  26 stdout, one structure per line. Each line consist
  27 of: The structure in dot bracket format with a "&" separating the
  28 two strands. The '<>' brackets represent snoRNA intramolecular
  29 interactions, while the '()' brackets represent intermolecular
  30 interactions between the snoRNA and its target.
  31 .PP
  32 The range of the structure in the two sequences in the format
  33 "from,to : from,to"; the energy of duplex structure in
  34 kcal/mol. If available the opening energy are also returned.
  35 .TP
  36 \fB\-\-help\fR
  37 Print help and exit
  38 .TP
  39 \fB\-\-detailed\-help\fR
  40 Print help, including all details and hidden
  41 options, and exit
  42 .TP
  43 \fB\-V\fR, \fB\-\-version\fR
  44 Print version and exit
  45 .SS "Input Options:"
  46 .IP
  47 Below are command line options which alter the general input behavior of
  48 RNAsnoop
  49 .TP
  50 \fB\-L\fR, \fB\-\-alignmentLength\fR=\fIINT\fR
  51 Limit the extent of the interactions to L
  52 nucleotides  (default=`25')
  53 .TP
  54 \fB\-C\fR, \fB\-\-constraint\fR
  55 Calculate the stem structure subject to
  56 constraints.
  57 .IP
  58 (default=off)
  59 .IP
  60 The program reads first the stem sequence, then a string containing
  61 constraints on the structure encoded with the symbols:
  62 .IP
  63 \&. (no constraint for this base)
  64 .IP
  65 | (the corresponding base has to be paired
  66 .IP
  67 x (the base is unpaired)
  68 .IP
  69 < (base i is paired with a base j>i)
  70 .IP
  71 \f(CW> (base i is paired with a base j<i)\fR
  72 .IP
  73 and matching brackets ( ) (base i pairs base j)
  74 .IP
  75 With the exception of "|", constraints will disallow all pairs conflicting
  76 with the constraint. This is usually sufficient to enforce the constraint,
  77 but occasionally a base may stay unpaired in spite of constraints. PF folding
  78 ignores constraints of type "|".
  79 .TP
  80 \fB\-s\fR, \fB\-\-query\fR=\fISTRING\fR
  81 File containing the query sequence.
  82 .IP
  83 Input sequences can be given piped to RNAsnoop or given in a query file with
  84 the \fB\-s\fR option. Note that the \fB\-s\fR option implies that the \fB\-t\fR option is also
  85 used
  86 .TP
  87 \fB\-t\fR, \fB\-\-target\fR=\fISTRING\fR
  88 File containing the target sequence.
  89 .IP
  90 Input sequences can be given piped to RNAsnoop or given in a target file with
  91 the \fB\-t\fR optionNote that the \fB\-t\fR option implies that the \fB\-s\fR option is also used
  92 .TP
  93 \fB\-S\fR, \fB\-\-suffix\fR=\fISTRING\fR
  94 Specificy the suffix that was added by RNAup to
  95 the accessibility files
  96 .IP
  97 (default=`_u1_to_30.out')
  98 .TP
  99 \fB\-P\fR, \fB\-\-from\-RNAplfold\fR=\fISTRING\fR
 100 Specify the directory where accessibility
 101 profile generated by RNAplfold are found
 102 .SS "Algorithms:"
 103 .IP
 104 Options which alter the computing behaviour of RNAplex.
 105 Please note that the options allowing to filter out snoRNA\-RNA
 106 duplexes expect the energy to be given in decacal/mol instead of
 107 kcal/mol. A threshold of \fB\-2\fR.8(kcal/mol) should be given as \fB\-280\fR(decacal/mol)
 108 .TP
 109 \fB\-A\fR, \fB\-\-alignment\-mode\fR
 110 Specify if RNAsnoop gets alignments or single
 111 sequences as input
 112 .IP
 113 (default=off)
 114 .TP
 115 \fB\-f\fR, \fB\-\-fast\-folding\fR=\fIINT\fR
 116 Speedup of the target search  (default=`1')
 117 .IP
 118 This option allows to decide if the backtracking has to be
 119 done (\fB\-f\fR 1) or not (\fB\-f\fR 0). For \fB\-f\fR 1 the structure is computed based
 120 on the standard energy model. This is the slowest mode of RNAsnoop. \fB\-f\fR
 121 0 is the fastest mode, as no structure are recomputed and only the
 122 interaction energy is returned
 123 .TP
 124 \fB\-c\fR, \fB\-\-extension\-cost\fR=\fIINT\fR
 125 Cost to add to each nucleotide in a duplex
 126 (default=`0')
 127 .IP
 128 Cost of extending a duplex by one nucleotide. Allows to find
 129 compact duplexes, having few/small bulges or interior loops. Only
 130 useful when no accessibility profiles are available. This option is
 131 disabled if accessibility profiles are used (\fB\-P\fR option)
 132 .TP
 133 \fB\-o\fR, \fB\-\-minimal\-right\-duplex\fR=\fIINT\fR
 134 Minimal Right Duplex Energy
 135 .IP
 136 (default=`\-270')
 137 .TP
 138 \fB\-l\fR, \fB\-\-minimal\-loop\-energy\fR=\fIINT\fR Minimal Right Duplex Energy
 139 (default=`\-280')
 140 .IP
 141 Minimal Stem Loop Energy of the snoRNA. The energy should be
 142 given in decacalories, i.e. a minimal stem\-loop energy of \fB\-2\fR.8
 143 kcal/mol corresponds to \fB\-280\fR decacal/mol
 144 .HP
 145 \fB\-p\fR, \fB\-\-minimal\-left\-duplex\fR=\fIINT\fR Minimal Left Duplex Energy
 146 .IP
 147 (default=`\-170')
 148 .TP
 149 \fB\-q\fR, \fB\-\-minimal\-duplex\fR=\fIINT\fR
 150 Minimal Duplex Energy
 151 .IP
 152 (default=`\-1090')
 153 .TP
 154 \fB\-d\fR, \fB\-\-duplex\-distance\fR=\fIINT\fR
 155 Distance between target 3' ends of two
 156 consecutive duplexes
 157 .IP
 158 (default=`2')
 159 .IP
 160 Distance between the target 3'ends of two consecutive
 161 duplexes. Should be set to the maximal length of interaction to get
 162 good results. Smaller d leads to larger overlaps between consecutive
 163 duplexes
 164 .HP
 165 \fB\-h\fR, \fB\-\-minimal\-stem\-length\fR=\fIINT\fR Minimal snoRNA stem length
 166 .IP
 167 (default=`5')
 168 .HP
 169 \fB\-i\fR, \fB\-\-maximal\-stem\-length\fR=\fIINT\fR Maximal snoRNA stem length
 170 .IP
 171 (default=`120')
 172 .TP
 173 \fB\-j\fR, \fB\-\-minimal\-duplex\-box\-length\fR=\fIINT\fR
 174 Minimal distance between the duplex end and the
 175 .IP
 176 H/ACA box
 177 .IP
 178 (default=`11')
 179 .TP
 180 \fB\-k\fR, \fB\-\-maximal\-duplex\-box\-length\fR=\fIINT\fR
 181 Maximal distance between the duplex end and the
 182 .IP
 183 H/ACA box
 184 .IP
 185 (default=`16')
 186 .TP
 187 \fB\-m\fR, \fB\-\-minimal\-snoRNA\-stem\-loop\-length\fR=\fIINT\fR
 188 Minimal number of nucleotides between the
 189 .IP
 190 beginning of stem loop and
 191 beginning of the snoRNA sequence
 192 .IP
 193 (default=`1')
 194 .TP
 195 \fB\-n\fR, \fB\-\-maximal\-snoRNA\-stem\-loop\-length\fR=\fIINT\fR
 196 Maximal number of nucleotides between the
 197 .IP
 198 beginning of stem loop and
 199 beginning of the snoRNA sequence
 200 .IP
 201 (default=`100000')
 202 .TP
 203 \fB\-v\fR, \fB\-\-minimal\-snoRNA\-duplex\-length\fR=\fIINT\fR
 204 Minimal distance between duplex start and
 205 .IP
 206 snoRNA
 207 .IP
 208 (default=`0')
 209 .TP
 210 \fB\-w\fR, \fB\-\-maximal\-snoRNA\-duplex\-length\fR=\fIINT\fR
 211 Maximal distance between duplex start and
 212 .IP
 213 snoRNA
 214 .IP
 215 (default=`0')
 216 .TP
 217 \fB\-x\fR, \fB\-\-minimal\-duplex\-stem\-energy\fR=\fIINT\fR
 218 Minimal duplex stem energy
 219 .IP
 220 (default=`\-1370')
 221 .TP
 222 \fB\-y\fR, \fB\-\-minimal\-total\-energy\fR=\fIINT\fR
 223 Minimal total energy
 224 .IP
 225 (default=`100000')
 226 .TP
 227 \fB\-a\fR, \fB\-\-maximal\-stem\-asymmetry\fR=\fIINT\fR
 228 Maximal snoRNA stem asymmetry
 229 .IP
 230 (default=`30')
 231 .TP
 232 \fB\-b\fR, \fB\-\-minimal\-lower\-stem\-energy\fR=\fIINT\fR
 233 Minimal lower stem energy
 234 .IP
 235 (default=`100000')
 236 .SS "Output options:"
 237 .IP
 238 Options that modifies the output
 239 .TP
 240 \fB\-e\fR, \fB\-\-energy\-threshold\fR=\fIDOUBLE\fR Maximal energy difference between the mfe and
 241 the desired suboptimal
 242 .IP
 243 (default=`\-1')
 244 .IP
 245 Energy range for a duplex to be returned. The threshold is set on the total
 246 energy of interaction, i.e. the hybridizationenergy corrected for opening
 247 energy if \fB\-a\fR is set or the energy corrected by \fB\-c\fR. If unset, only the mfe
 248 will be returned
 249 .TP
 250 \fB\-I\fR, \fB\-\-produce\-ps\fR
 251 Draw annotated 2D structures for a list of
 252 dot\-bracket structures
 253 .IP
 254 (default=off)
 255 .IP
 256 This option allows to produce interaction figures in PS\-format with
 257 conservation/accessibility annotation, if available
 258 .TP
 259 \fB\-O\fR, \fB\-\-output_directory\fR=\fISTRING\fR Set where the generated figures should be
 260 stored
 261 .IP
 262 (default=`./')
 263 .TP
 264 \fB\-N\fR, \fB\-\-direct\-redraw\fR
 265 Outputs 2D interactions concurrently with the
 266 interaction calculation for each suboptimal
 267 interaction. The \fB\-I\fR option should be
 268 preferred.
 269 .IP
 270 (default=off)
 271 .TP
 272 \fB\-U\fR, \fB\-\-from\-RNAup\fR=\fISTRING\fR
 273 Specify the directory where accessibility
 274 profiles generated by RNAup are found
 275 .SH AUTHOR
 276
 277 Hakim Tafer, Ivo L. Hofacker
 278 .SH REFERENCES
 279 .I If you use this program in your work you might want to cite:
 280
 281 R. Lorenz, S.H. Bernhart, C. Hoener zu Siederdissen, H. Tafer, C. Flamm, P.F. Stadler and I.L. Hofacker (2011),
 282 "ViennaRNA Package 2.0",
 283 Algorithms for Molecular Biology: 6:26
 284
 285 I.L. Hofacker, W. Fontana, P.F. Stadler, S. Bonhoeffer, M. Tacker, P. Schuster (1994),
 286 "Fast Folding and Comparison of RNA Secondary Structures",
 287 Monatshefte f. Chemie: 125, pp 167-188
 288
 289
 290 The calculation of duplex structure is based on dynamic programming algorithm originally
 291 developed by Rehmsmeier and in parallel by Hofacker.
 292
 293 H. Tafer, S. Kehr, J. Hertel, I.L. Hofacker, P.F. Stadler (2009),
 294 "RNAsnoop: efficient target prediction for H/ACA snoRNAs.",
 295 Bioinformatics: 26(5), pp 610-616
 296
 297 .I The energy parameters are taken from:
 298
 299 D.H. Mathews, M.D. Disney, D. Matthew, J.L. Childs, S.J. Schroeder, J. Susan, M. Zuker, D.H. Turner (2004),
 300 "Incorporating chemical modification constraints into a dynamic programming algorithm for prediction of RNA secondary structure",
 301 Proc. Natl. Acad. Sci. USA: 101, pp 7287-7292
 302
 303 D.H Turner, D.H. Mathews (2009),
 304 "NNDB: The nearest neighbor parameter database for predicting stability of nucleic acid secondary structure",
 305 Nucleic Acids Research: 38, pp 280-282
 306 .SH "REPORTING BUGS"
 307 If in doubt our program is right, nature is at fault.
 308 .br
 309 Comments should be sent to rna@tbi.univie.ac.at.