doc/manual.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4   <title>Bowtie Manual - </title>
   5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6   <meta name="generator" content="pandoc" />
   7   <link rel="stylesheet" href="style.css" type="text/css" />
   8 </head>
   9 <body>
  10 <h1>Table of Contents</h1>
  11 <div id="TOC"
  12 ><ul
  13   ><li
  14     ><a href="#what-is-bowtie"
  15       >What is Bowtie?</a
  16       ></li
  17     ><li
  18     ><a href="#what-isnt-bowtie"
  19       >What isn't Bowtie?</a
  20       ></li
  21     ><li
  22     ><a href="#obtaining-bowtie"
  23       >Obtaining Bowtie</a
  24       ><ul
  25       ><li
  26         ><a href="#building-from-source"
  27           >Building from source</a
  28           ></li
  29         ></ul
  30       ></li
  31     ><li
  32     ><a href="#the-bowtie-aligner"
  33       >The <code
  34         >bowtie</code
  35         > aligner</a
  36       ><ul
  37       ><li
  38         ><a href="#the--n-alignment-mode"
  39           >The <code
  40             >-n</code
  41             > alignment mode</a
  42           ></li
  43         ><li
  44         ><a href="#the--v-alignment-mode"
  45           >The <code
  46             >-v</code
  47             > alignment mode</a
  48           ></li
  49         ><li
  50         ><a href="#strata"
  51           >Strata</a
  52           ></li
  53         ><li
  54         ><a href="#reporting-modes"
  55           >Reporting Modes</a
  56           ><ul
  57           ><li
  58             ><a href="#example-1--a"
  59               >Example 1: <code
  60                 >-a</code
  61                 ></a
  62               ></li
  63             ><li
  64             ><a href="#example-2--k-3"
  65               >Example 2: <code
  66                 >-k 3</code
  67                 ></a
  68               ></li
  69             ><li
  70             ><a href="#example-3--k-6"
  71               >Example 3: <code
  72                 >-k 6</code
  73                 ></a
  74               ></li
  75             ><li
  76             ><a href="#example-4-default--k-1"
  77               >Example 4: default (<code
  78                 >-k 1</code
  79                 >)</a
  80               ></li
  81             ><li
  82             ><a href="#example-5--a---best"
  83               >Example 5: <code
  84                 >-a --best</code
  85                 ></a
  86               ></li
  87             ><li
  88             ><a href="#example-6--a---best---strata"
  89               >Example 6: <code
  90                 >-a --best --strata</code
  91                 ></a
  92               ></li
  93             ><li
  94             ><a href="#example-7--a--m-3"
  95               >Example 7: <code
  96                 >-a -m 3</code
  97                 ></a
  98               ></li
  99             ><li
 100             ><a href="#example-8--a--m-5"
 101               >Example 8: <code
 102                 >-a -m 5</code
 103                 ></a
 104               ></li
 105             ><li
 106             ><a href="#example-9--a--m-3---best---strata"
 107               >Example 9: <code
 108                 >-a -m 3 --best --strata</code
 109                 ></a
 110               ></li
 111             ></ul
 112           ></li
 113         ><li
 114         ><a href="#paired-end-alignment"
 115           >Paired-end Alignment</a
 116           ></li
 117         ><li
 118         ><a href="#colorspace-alignment"
 119           >Colorspace Alignment</a
 120           ><ul
 121           ><li
 122             ><a href="#colorspace-reads"
 123               >Colorspace reads</a
 124               ></li
 125             ><li
 126             ><a href="#building-a-colorspace-index"
 127               >Building a colorspace index</a
 128               ></li
 129             ><li
 130             ><a href="#decoding-colorspace-alignments"
 131               >Decoding colorspace alignments</a
 132               ></li
 133             ><li
 134             ><a href="#paired-end-colorspace-alignment"
 135               >Paired-end colorspace alignment</a
 136               ></li
 137             ></ul
 138           ></li
 139         ><li
 140         ><a href="#performance-tuning"
 141           >Performance Tuning</a
 142           ></li
 143         ><li
 144         ><a href="#command-line"
 145           >Command Line</a
 146           ><ul
 147           ><li
 148             ><a href="#main-arguments"
 149               >Main arguments</a
 150               ></li
 151             ><li
 152             ><a href="#options"
 153               >Options</a
 154               ><ul
 155               ><li
 156                 ><a href="#input"
 157                   >Input</a
 158                   ></li
 159                 ><li
 160                 ><a href="#alignment"
 161                   >Alignment</a
 162                   ></li
 163                 ><li
 164                 ><a href="#reporting"
 165                   >Reporting</a
 166                   ></li
 167                 ><li
 168                 ><a href="#output"
 169                   >Output</a
 170                   ></li
 171                 ><li
 172                 ><a href="#colorspace"
 173                   >Colorspace</a
 174                   ></li
 175                 ><li
 176                 ><a href="#sam"
 177                   >SAM</a
 178                   ></li
 179                 ><li
 180                 ><a href="#performance"
 181                   >Performance</a
 182                   ></li
 183                 ><li
 184                 ><a href="#other"
 185                   >Other</a
 186                   ></li
 187                 ></ul
 188               ></li
 189             ></ul
 190           ></li
 191         ><li
 192         ><a href="#default-bowtie-output"
 193           >Default <code
 194             >bowtie</code
 195             > output</a
 196           ></li
 197         ><li
 198         ><a href="#sam-bowtie-output"
 199           >SAM <code
 200             >bowtie</code
 201             > output</a
 202           ></li
 203         ></ul
 204       ></li
 205     ><li
 206     ><a href="#the-bowtie-build-indexer"
 207       >The <code
 208         >bowtie-build</code
 209         > indexer</a
 210       ><ul
 211       ><li
 212         ><a href="#command-line-1"
 213           >Command Line</a
 214           ><ul
 215           ><li
 216             ><a href="#main-arguments-1"
 217               >Main arguments</a
 218               ></li
 219             ><li
 220             ><a href="#options-1"
 221               >Options</a
 222               ></li
 223             ></ul
 224           ></li
 225         ></ul
 226       ></li
 227     ><li
 228     ><a href="#the-bowtie-inspect-index-inspector"
 229       >The <code
 230         >bowtie-inspect</code
 231         > index inspector</a
 232       ><ul
 233       ><li
 234         ><a href="#command-line-2"
 235           >Command Line</a
 236           ><ul
 237           ><li
 238             ><a href="#main-arguments-2"
 239               >Main arguments</a
 240               ></li
 241             ><li
 242             ><a href="#options-2"
 243               >Options</a
 244               ></li
 245             ></ul
 246           ></li
 247         ></ul
 248       ></li
 249     ></ul
 250   ></div
 251 >
 252 <!--
 253  ! This manual is written in "markdown" format and thus contains some
 254  ! distracting clutter encoding information about how to convert to
 255  ! HTML.  See 'MANUAL' for a clearer version of this document.
 256   -->
 257 <h1 id="what-is-bowtie"
 258 ><a href="#TOC"
 259   >What is Bowtie?</a
 260   ></h1
 261 ><p
 262 ><a href="http://bowtie-bio.sf.net"
 263   >Bowtie</a
 264   > is an ultrafast, memory-efficient short read aligner geared toward quickly aligning large sets of short DNA sequences (reads) to large genomes. It aligns 35-base-pair reads to the human genome at a rate of 25 million reads per hour on a typical workstation. Bowtie indexes the genome with a <a href="http://en.wikipedia.org/wiki/Burrows-Wheeler_transform"
 265   >Burrows-Wheeler</a
 266   > index to keep its memory footprint small: for the human genome, the index is typically about 2.2 GB (for unpaired alignment) or 2.9 GB (for paired-end or colorspace alignment). Multiple processors can be used simultaneously to achieve greater alignment speed. Bowtie can also output alignments in the standard <a href="http://samtools.sourceforge.net/SAM1.pdf"
 267   >SAM</a
 268   > format, allowing Bowtie to interoperate with other tools supporting SAM, including the <a href="http://samtools.sourceforge.net/"
 269   >SAMtools</a
 270   > consensus, SNP, and indel callers. Bowtie runs on the command line under Windows, Mac OS X, Linux, and Solaris.</p
 271 ><p
 272 ><a href="http://bowtie-bio.sf.net"
 273   >Bowtie</a
 274   > also forms the basis for other tools, including <a href="http://tophat.cbcb.umd.edu/"
 275   >TopHat</a
 276   >: a fast splice junction mapper for RNA-seq reads, <a href="http://cufflinks.cbcb.umd.edu/"
 277   >Cufflinks</a
 278   >: a tool for transcriptome assembly and isoform quantitiation from RNA-seq reads, <a href="http://bowtie-bio.sf.net/crossbow"
 279   >Crossbow</a
 280   >: a cloud-computing software tool for large-scale resequencing data,and <a href="http://bowtie-bio.sf.net/myrna"
 281   >Myrna</a
 282   >: a cloud computing tool for calculating differential gene expression in large RNA-seq datasets.</p
 283 ><p
 284 >If you use <a href="http://bowtie-bio.sf.net"
 285   >Bowtie</a
 286   > for your published research, please cite the <a href="http://genomebiology.com/2009/10/3/R25"
 287   >Bowtie paper</a
 288   >.</p
 289 ><h1 id="what-isnt-bowtie"
 290 ><a href="#TOC"
 291   >What isn't Bowtie?</a
 292   ></h1
 293 ><p
 294 >Bowtie is not a general-purpose alignment tool like <a href="http://mummer.sourceforge.net/"
 295   >MUMmer</a
 296   >, <a href="http://blast.ncbi.nlm.nih.gov/Blast.cgi"
 297   >BLAST</a
 298   > or <a href="http://www.vmatch.de/"
 299   >Vmatch</a
 300   >. Bowtie works best when aligning short reads to large genomes, though it supports arbitrarily small reference sequences (e.g. amplicons) and reads as long as 1024 bases. Bowtie is designed to be extremely fast for sets of short reads where (a) many of the reads have at least one good, valid alignment, (b) many of the reads are relatively high-quality, and (c) the number of alignments reported per read is small (close to 1).</p
 301 ><p
 302 >Bowtie does not yet report gapped alignments; this is future work.</p
 303 ><h1 id="obtaining-bowtie"
 304 ><a href="#TOC"
 305   >Obtaining Bowtie</a
 306   ></h1
 307 ><p
 308 >You may download either Bowtie sources or binaries for your platform from the <a href="https://sourceforge.net/projects/bowtie-bio/files/bowtie/"
 309   >Download</a
 310   > section of the Sourceforge project site. Binaries are currently available for Intel architectures (<code
 311   >i386</code
 312   > and <code
 313   >x86_64</code
 314   >) running Linux, Windows, and Mac OS X.</p
 315 ><h2 id="building-from-source"
 316 ><a href="#TOC"
 317   >Building from source</a
 318   ></h2
 319 ><p
 320 >Building Bowtie from source requires a GNU-like environment that includes GCC, GNU Make and other basics. It should be possible to build Bowtie on a vanilla Linux or Mac installation. Bowtie can also be built on Windows using <a href="http://www.cygwin.com/"
 321   >Cygwin</a
 322   > or <a href="http://www.mingw.org/"
 323   >MinGW</a
 324   >. We recommend <a href="http://www.tdragon.net/recentgcc/"
 325   >TDM's MinGW Build</a
 326   >. If using <a href="http://www.mingw.org/"
 327   >MinGW</a
 328   >, you must also have <a href="http://www.mingw.org/wiki/msys"
 329   >MSYS</a
 330   > installed.</p
 331 ><p
 332 >To build Bowtie, extract the sources, change to the extracted directory, and run GNU <code
 333   >make</code
 334   > (usually with the command <code
 335   >make</code
 336   >, but sometimes with <code
 337   >gmake</code
 338   >) with no arguments. If building with <a href="http://www.mingw.org/"
 339   >MinGW</a
 340   >, run <code
 341   >make</code
 342   > from the <a href="http://www.mingw.org/wiki/msys"
 343   >MSYS</a
 344   > command line.</p
 345 ><p
 346 >To support the <a href="#bowtie-options-p"
 347   ><code
 348     >-p</code
 349     ></a
 350   > (multithreading) option, Bowtie needs the <code
 351   >pthreads</code
 352   > library. To compile Bowtie without <code
 353   >pthreads</code
 354   > (which disables <a href="#bowtie-options-p"
 355   ><code
 356     >-p</code
 357     ></a
 358   >), use <code
 359   >make BOWTIE_PTHREADS=0</code
 360   >.</p
 361 ><h1 id="the-bowtie-aligner"
 362 ><a href="#TOC"
 363   >The <code
 364     >bowtie</code
 365     > aligner</a
 366   ></h1
 367 ><p
 368 ><code
 369   >bowtie</code
 370   > takes an index and a set of reads as input and outputs a list of alignments. Alignments are selected according to a combination of the <a href="#bowtie-options-v"
 371   ><code
 372     >-v</code
 373     ></a
 374   >/<a href="#bowtie-options-n"
 375   ><code
 376     >-n</code
 377     ></a
 378   >/<a href="#bowtie-options-e"
 379   ><code
 380     >-e</code
 381     ></a
 382   >/<a href="#bowtie-options-l"
 383   ><code
 384     >-l</code
 385     ></a
 386   > options (plus the <a href="#bowtie-options-I"
 387   ><code
 388     >-I</code
 389     ></a
 390   >/<a href="#bowtie-options-X"
 391   ><code
 392     >-X</code
 393     ></a
 394   >/<a href="#bowtie-options-fr"
 395   ><code
 396     >--fr</code
 397     ></a
 398   >/<a href="#bowtie-options-fr"
 399   ><code
 400     >--rf</code
 401     ></a
 402   >/ <a href="#bowtie-options-fr"
 403   ><code
 404     >--ff</code
 405     ></a
 406   > options for paired-end alignment), which define which alignments are legal, and the <a href="#bowtie-options-k"
 407   ><code
 408     >-k</code
 409     ></a
 410   >/<a href="#bowtie-options-a"
 411   ><code
 412     >-a</code
 413     ></a
 414   >/<a href="#bowtie-options-m"
 415   ><code
 416     >-m</code
 417     ></a
 418   >/<a href="#bowtie-options-M"
 419   ><code
 420     >-M</code
 421     ></a
 422   >/<a href="#bowtie-options-best"
 423   ><code
 424     >--best</code
 425     ></a
 426   >/<a href="#bowtie-options-strata"
 427   ><code
 428     >--strata</code
 429     ></a
 430   > options which define which and how many legal alignments should be reported.</p
 431 ><p
 432 >By default, Bowtie enforces an alignment policy similar to <a href="http://maq.sf.net"
 433   >Maq</a
 434   >'s default quality-aware policy (<a href="#bowtie-options-n"
 435   ><code
 436     >-n</code
 437     ></a
 438   > 2 <a href="#bowtie-options-l"
 439   ><code
 440     >-l</code
 441     ></a
 442   > 28 <a href="#bowtie-options-e"
 443   ><code
 444     >-e</code
 445     ></a
 446   > 70). See <a href="#the--n-alignment-mode"
 447   >the -n alignment mode</a
 448   > section of the manual for details about this mode. But Bowtie can also enforce a simpler end-to-end k-difference policy (e.g. with <a href="#bowtie-options-v"
 449   ><code
 450     >-v</code
 451     ></a
 452   > 2). See <a href="#the--v-alignment-mode"
 453   >the -v alignment mode</a
 454   > section of the manual for details about that mode. [The -n alignment mode] and <a href="#the--v-alignment-mode"
 455   >the -v alignment mode</a
 456   > are mutually exclusive.</p
 457 ><p
 458 >Bowtie works best when aligning short reads to large genomes (e.g. human or mouse), though it supports arbitrarily small reference sequences and reads as long as 1024 bases. Bowtie is designed to be very fast for sets of short reads where a) many reads have at least one good, valid alignment, b) many reads are relatively high-quality, c) the number of alignments reported per read is small (close to 1). These criteria are generally satisfied in the context of modern short-read analyses such as RNA-seq, ChIP-seq, other types of -seq, and mammalian resequencing. You may observe longer running times in other research contexts.</p
 459 ><p
 460 >If <code
 461   >bowtie</code
 462   > is too slow for your application, try some of the performance-tuning hints described in the [Performance Tuning] section below.</p
 463 ><p
 464 >Alignments involving one or more ambiguous reference characters (<code
 465   >N</code
 466   >, <code
 467   >-</code
 468   >, <code
 469   >R</code
 470   >, <code
 471   >Y</code
 472   >, etc.) are considered invalid by Bowtie. This is true only for ambiguous characters in the reference; alignments involving ambiguous characters in the read are legal, subject to the alignment policy. Ambiguous characters in the read mismatch all other characters. Alignments that &quot;fall off&quot; the reference sequence are not considered valid.</p
 473 ><p
 474 >The process by which <code
 475   >bowtie</code
 476   > chooses an alignment to report is randomized in order to avoid &quot;mapping bias&quot; - the phenomenon whereby an aligner systematically fails to report a particular class of good alignments, causing spurious &quot;holes&quot; in the comparative assembly. Whenever <code
 477   >bowtie</code
 478   > reports a subset of the valid alignments that exist, it makes an effort to sample them randomly. This randomness flows from a simple seeded pseudo-random number generator and is deterministic in the sense that Bowtie will always produce the same results for the same read when run with the same initial &quot;seed&quot; value (see <a href="#bowtie-options-seed"
 479   ><code
 480     >--seed</code
 481     ></a
 482   > option).</p
 483 ><p
 484 >In the default mode, <code
 485   >bowtie</code
 486   > can exhibit strand bias. Strand bias occurs when input reference and reads are such that (a) some reads align equally well to sites on the forward and reverse strands of the reference, and (b) the number of such sites on one strand is different from the number on the other strand. When this happens for a given read, <code
 487   >bowtie</code
 488   > effectively chooses one strand or the other with 50% probability, then reports a randomly-selected alignment for that read from among the sites on the selected strand. This tends to overassign alignments to the sites on the strand with fewer sites and underassign to sites on the strand with more sites. The effect is mitigated, though it may not be eliminated, when reads are longer or when paired-end reads are used. Running Bowtie in <a href="#bowtie-options-best"
 489   ><code
 490     >--best</code
 491     ></a
 492   > mode eliminates strand bias by forcing Bowtie to select one strand or the other with a probability that is proportional to the number of best sites on the strand.</p
 493 ><p
 494 >Gapped alignments are not currently supported, but support is planned for a future release.</p
 495 ><h2 id="the--n-alignment-mode"
 496 ><a href="#TOC"
 497   >The <code
 498     >-n</code
 499     > alignment mode</a
 500   ></h2
 501 ><p
 502 >When the <a href="#bowtie-options-n"
 503   ><code
 504     >-n</code
 505     ></a
 506   > option is specified (which is the default), <code
 507   >bowtie</code
 508   > determines which alignments are valid according to the following policy, which is similar to <a href="http://maq.sf.net"
 509   >Maq</a
 510   >'s default policy.</p
 511 ><ol style="list-style-type: decimal;"
 512 ><li
 513   ><p
 514     >Alignments may have no more than <code
 515       >N</code
 516       > mismatches (where <code
 517       >N</code
 518       > is a number 0-3, set with <a href="#bowtie-options-n"
 519       ><code
 520         >-n</code
 521         ></a
 522       >) in the first <code
 523       >L</code
 524       > bases (where <code
 525       >L</code
 526       > is a number 5 or greater, set with <a href="#bowtie-options-l"
 527       ><code
 528         >-l</code
 529         ></a
 530       >) on the high-quality (left) end of the read. The first <code
 531       >L</code
 532       > bases are called the &quot;seed&quot;.</p
 533     ></li
 534   ><li
 535   ><p
 536     >The sum of the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
 537       >Phred quality</a
 538       > values at <em
 539       >all</em
 540       > mismatched positions (not just in the seed) may not exceed <code
 541       >E</code
 542       > (set with <a href="#bowtie-options-e"
 543       ><code
 544         >-e</code
 545         ></a
 546       >). Where qualities are unavailable (e.g. if the reads are from a FASTA file), the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
 547       >Phred quality</a
 548       > defaults to 40.</p
 549     ></li
 550   ></ol
 551 ><p
 552 >The <a href="#bowtie-options-n"
 553   ><code
 554     >-n</code
 555     ></a
 556   > option is mutually exclusive with the <a href="#bowtie-options-v"
 557   ><code
 558     >-v</code
 559     ></a
 560   > option.</p
 561 ><p
 562 >If there are many possible alignments satisfying these criteria, Bowtie gives preference to alignments with fewer mismatches and where the sum from criterion 2 is smaller. When the <a href="#bowtie-options-best"
 563   ><code
 564     >--best</code
 565     ></a
 566   > option is specified, Bowtie guarantees the reported alignment(s) are &quot;best&quot; in terms of these criteria (criterion 1 has priority), and that the alignments are reported in best-to-worst order. Bowtie is somewhat slower when <a href="#bowtie-options-best"
 567   ><code
 568     >--best</code
 569     ></a
 570   > is specified.</p
 571 ><p
 572 >Note that <a href="http://maq.sf.net"
 573   >Maq</a
 574   > internally rounds base qualities to the nearest 10 and rounds qualities greater than 30 to 30. To maintain compatibility, Bowtie does the same. Rounding can be suppressed with the <a href="#bowtie-options-nomaqround"
 575   ><code
 576     >--nomaqround</code
 577     ></a
 578   > option.</p
 579 ><p
 580 >Bowtie is not fully sensitive in <a href="#bowtie-options-n"
 581   ><code
 582     >-n</code
 583     ></a
 584   > 2 and <a href="#bowtie-options-n"
 585   ><code
 586     >-n</code
 587     ></a
 588   > 3 modes by default. In these modes Bowtie imposes a &quot;backtracking limit&quot; to limit effort spent trying to find valid alignments for low-quality reads unlikely to have any. This may cause bowtie to miss some legal 2- and 3-mismatch alignments. The limit is set to a reasonable default (125 without <a href="#bowtie-options-best"
 589   ><code
 590     >--best</code
 591     ></a
 592   >, 800 with <a href="#bowtie-options-best"
 593   ><code
 594     >--best</code
 595     ></a
 596   >), but the user may decrease or increase the limit using the <a href="#bowtie-options-maxbts"
 597   ><code
 598     >--maxbts</code
 599     ></a
 600   > and/or <a href="#bowtie-options-y"
 601   ><code
 602     >-y</code
 603     ></a
 604   > options. <a href="#bowtie-options-y"
 605   ><code
 606     >-y</code
 607     ></a
 608   > mode is relatively slow but guarantees full sensitivity.</p
 609 ><h2 id="the--v-alignment-mode"
 610 ><a href="#TOC"
 611   >The <code
 612     >-v</code
 613     > alignment mode</a
 614   ></h2
 615 ><p
 616 >In <a href="#bowtie-options-v"
 617   ><code
 618     >-v</code
 619     ></a
 620   > mode, alignments may have no more than <code
 621   >V</code
 622   > mismatches, where <code
 623   >V</code
 624   > may be a number from 0 through 3 set using the <a href="#bowtie-options-v"
 625   ><code
 626     >-v</code
 627     ></a
 628   > option. Quality values are ignored. The <a href="#bowtie-options-v"
 629   ><code
 630     >-v</code
 631     ></a
 632   > option is mutually exclusive with the <a href="#bowtie-options-n"
 633   ><code
 634     >-n</code
 635     ></a
 636   > option.</p
 637 ><p
 638 >If there are many legal alignments, Bowtie gives preference to alignments with fewer mismatches. When the <a href="#bowtie-options-best"
 639   ><code
 640     >--best</code
 641     ></a
 642   > option is specified, Bowtie guarantees the reported alignment(s) are &quot;best&quot; in terms of the number of mismatches, and that the alignments are reported in best-to-worst order. Bowtie is somewhat slower when <a href="#bowtie-options-best"
 643   ><code
 644     >--best</code
 645     ></a
 646   > is specified.</p
 647 ><h2 id="strata"
 648 ><a href="#TOC"
 649   >Strata</a
 650   ></h2
 651 ><p
 652 >In <a href="#the--n-alignment-mode"
 653   >the -n alignment mode</a
 654   >, an alignment's &quot;stratum&quot; is defined as the number of mismatches in the &quot;seed&quot; region, i.e. the leftmost <code
 655   >L</code
 656   > bases, where <code
 657   >L</code
 658   > is set with the <a href="#bowtie-options-l"
 659   ><code
 660     >-l</code
 661     ></a
 662   > option. In <a href="#the--v-alignment-mode"
 663   >the -v alignment mode</a
 664   >, an alignment's stratum is defined as the total number of mismatches in the entire alignment. Some of Bowtie's options (e.g. <a href="#bowtie-options-strata"
 665   ><code
 666     >--strata</code
 667     ></a
 668   > and <a href="#bowtie-options-m"
 669   ><code
 670     >-m</code
 671     ></a
 672   > use the notion of &quot;stratum&quot; to limit or expand the scope of reportable alignments.</p
 673 ><h2 id="reporting-modes"
 674 ><a href="#TOC"
 675   >Reporting Modes</a
 676   ></h2
 677 ><p
 678 >With the <a href="#bowtie-options-k"
 679   ><code
 680     >-k</code
 681     ></a
 682   >, <a href="#bowtie-options-a"
 683   ><code
 684     >-a</code
 685     ></a
 686   >, <a href="#bowtie-options-m"
 687   ><code
 688     >-m</code
 689     ></a
 690   >, <a href="#bowtie-options-M"
 691   ><code
 692     >-M</code
 693     ></a
 694   >, <a href="#bowtie-options-best"
 695   ><code
 696     >--best</code
 697     ></a
 698   > and <a href="#bowtie-options-strata"
 699   ><code
 700     >--strata</code
 701     ></a
 702   > options, the user can flexibily select which alignments are reported. Below we demonstrate a few ways in which these options can be combined. All examples are using the <code
 703   >e_coli</code
 704   > index packaged with Bowtie. The <a href="#bowtie-options-suppress"
 705   ><code
 706     >--suppress</code
 707     ></a
 708   > option is used to keep the output concise and some output is elided for clarity.</p
 709 ><h3 id="example-1--a"
 710 ><a href="#TOC"
 711   >Example 1: <code
 712     >-a</code
 713     ></a
 714   ></h3
 715 ><pre
 716 ><code
 717   >$ ./bowtie -a -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 718 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 719 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 720 -   gi|110640213|ref|NC_008253.1|   4930433 4:G&gt;T,6:C&gt;G
 721 -   gi|110640213|ref|NC_008253.1|   905664  6:A&gt;G,7:G&gt;T
 722 +   gi|110640213|ref|NC_008253.1|   1093035 2:T&gt;G,15:A&gt;T
 723 </code
 724   ></pre
 725 ><p
 726 >Specifying <a href="#bowtie-options-a"
 727   ><code
 728     >-a</code
 729     ></a
 730   > instructs bowtie to report <em
 731   >all</em
 732   > valid alignments, subject to the alignment policy: <a href="#bowtie-options-v"
 733   ><code
 734     >-v</code
 735     ></a
 736   > 2. In this case, bowtie finds 5 inexact hits in the E. coli genome; 1 hit (the 2nd one listed) has 1 mismatch, and the other 4 hits have 2 mismatches. Four are on the reverse reference strand and one is on the forward strand. Note that they are not listed in best-to-worst order.</p
 737 ><h3 id="example-2--k-3"
 738 ><a href="#TOC"
 739   >Example 2: <code
 740     >-k 3</code
 741     ></a
 742   ></h3
 743 ><pre
 744 ><code
 745   >$ ./bowtie -k 3 -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 746 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 747 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 748 -   gi|110640213|ref|NC_008253.1|   4930433 4:G&gt;T,6:C&gt;G
 749 </code
 750   ></pre
 751 ><p
 752 >Specifying <a href="#bowtie-options-k"
 753   ><code
 754     >-k</code
 755     ></a
 756   > 3 instructs bowtie to report up to 3 valid alignments. In this case, a total of 5 valid alignments exist (see <a href="#example-1"
 757   >Example 1</a
 758   >); <code
 759   >bowtie</code
 760   > reports 3 out of those 5. <a href="#bowtie-options-k"
 761   ><code
 762     >-k</code
 763     ></a
 764   > can be set to any integer greater than 0.</p
 765 ><h3 id="example-3--k-6"
 766 ><a href="#TOC"
 767   >Example 3: <code
 768     >-k 6</code
 769     ></a
 770   ></h3
 771 ><pre
 772 ><code
 773   >$ ./bowtie -k 6 -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 774 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 775 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 776 -   gi|110640213|ref|NC_008253.1|   4930433 4:G&gt;T,6:C&gt;G
 777 -   gi|110640213|ref|NC_008253.1|   905664  6:A&gt;G,7:G&gt;T
 778 +   gi|110640213|ref|NC_008253.1|   1093035 2:T&gt;G,15:A&gt;T
 779 </code
 780   ></pre
 781 ><p
 782 >Specifying <a href="#bowtie-options-k"
 783   ><code
 784     >-k</code
 785     ></a
 786   > 6 instructs bowtie to report up to 6 valid alignments. In this case, a total of 5 valid alignments exist, so <code
 787   >bowtie</code
 788   > reports all 5.</p
 789 ><h3 id="example-4-default--k-1"
 790 ><a href="#TOC"
 791   >Example 4: default (<code
 792     >-k 1</code
 793     >)</a
 794   ></h3
 795 ><pre
 796 ><code
 797   >$ ./bowtie -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 798 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 799 </code
 800   ></pre
 801 ><p
 802 >Leaving the reporting options at their defaults causes <code
 803   >bowtie</code
 804   > to report the first valid alignment it encounters. Because <a href="#bowtie-options-best"
 805   ><code
 806     >--best</code
 807     ></a
 808   > was not specified, we are not guaranteed that bowtie will report the best alignment, and in this case it does not (the 1-mismatch alignment from the previous example would have been better). The default reporting mode is equivalent to <a href="#bowtie-options-k"
 809   ><code
 810     >-k</code
 811     ></a
 812   > 1.</p
 813 ><h3 id="example-5--a---best"
 814 ><a href="#TOC"
 815   >Example 5: <code
 816     >-a --best</code
 817     ></a
 818   ></h3
 819 ><pre
 820 ><code
 821   >$ ./bowtie -a --best -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 822 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 823 +   gi|110640213|ref|NC_008253.1|   1093035 2:T&gt;G,15:A&gt;T
 824 -   gi|110640213|ref|NC_008253.1|   905664  6:A&gt;G,7:G&gt;T
 825 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 826 -   gi|110640213|ref|NC_008253.1|   4930433 4:G&gt;T,6:C&gt;G
 827 </code
 828   ></pre
 829 ><p
 830 >Specifying <a href="#bowtie-options-best"
 831   ><code
 832     >-a</code
 833     ></a
 834   > results in the same alignments being printed as if just <a href="#bowtie-options-a"
 835   ><code
 836     >-a</code
 837     ></a
 838   > had been specified, but they are guaranteed to be reported in best-to-worst order.</p
 839 ><h3 id="example-6--a---best---strata"
 840 ><a href="#TOC"
 841   >Example 6: <code
 842     >-a --best --strata</code
 843     ></a
 844   ></h3
 845 ><pre
 846 ><code
 847   >$ ./bowtie -a --best --strata -v 2 --suppress 1,5,6,7 e_coli -c ATGCATCATGCGCCAT
 848 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 849 </code
 850   ></pre
 851 ><p
 852 >Specifying <a href="#bowtie-options-strata"
 853   ><code
 854     >--strata</code
 855     ></a
 856   > in addition to <a href="#bowtie-options-a"
 857   ><code
 858     >-a</code
 859     ></a
 860   > and <a href="#bowtie-options-best"
 861   ><code
 862     >--best</code
 863     ></a
 864   > causes <code
 865   >bowtie</code
 866   > to report only those alignments in the best alignment &quot;stratum&quot;. The alignments in the best stratum are those having the least number of mismatches (or mismatches just in the &quot;seed&quot; portion of the alignment in the case of <a href="#bowtie-options-n"
 867   ><code
 868     >-n</code
 869     ></a
 870   > mode). Note that if <a href="#bowtie-options-strata"
 871   ><code
 872     >--strata</code
 873     ></a
 874   > is specified, <a href="#bowtie-options-best"
 875   ><code
 876     >--best</code
 877     ></a
 878   > must also be specified.</p
 879 ><h3 id="example-7--a--m-3"
 880 ><a href="#TOC"
 881   >Example 7: <code
 882     >-a -m 3</code
 883     ></a
 884   ></h3
 885 ><pre
 886 ><code
 887   >$ ./bowtie -a -m 3 -v 2 e_coli -c ATGCATCATGCGCCAT
 888 No alignments
 889 </code
 890   ></pre
 891 ><p
 892 >Specifying <a href="#bowtie-options-m"
 893   ><code
 894     >-m</code
 895     ></a
 896   > 3 instructs bowtie to refrain from reporting any alignments for reads having more than 3 reportable alignments. The <a href="#bowtie-options-m"
 897   ><code
 898     >-m</code
 899     ></a
 900   > option is useful when the user would like to guarantee that reported alignments are &quot;unique&quot;, for some definition of unique.</p
 901 ><p
 902 >Example 1 showed that the read has 5 reportable alignments when <a href="#bowtie-options-a"
 903   ><code
 904     >-a</code
 905     ></a
 906   > and <a href="#bowtie-options-v"
 907   ><code
 908     >-v</code
 909     ></a
 910   > 2 are specified, so the <a href="#bowtie-options-m"
 911   ><code
 912     >-m</code
 913     ></a
 914   > 3 limit causes bowtie to output no alignments.</p
 915 ><h3 id="example-8--a--m-5"
 916 ><a href="#TOC"
 917   >Example 8: <code
 918     >-a -m 5</code
 919     ></a
 920   ></h3
 921 ><pre
 922 ><code
 923   >$ ./bowtie -a -m 5 -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 924 -   gi|110640213|ref|NC_008253.1|   148810  10:A&gt;G,13:C&gt;G
 925 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 926 -   gi|110640213|ref|NC_008253.1|   4930433 4:G&gt;T,6:C&gt;G
 927 -   gi|110640213|ref|NC_008253.1|   905664  6:A&gt;G,7:G&gt;T
 928 +   gi|110640213|ref|NC_008253.1|   1093035 2:T&gt;G,15:A&gt;T
 929 </code
 930   ></pre
 931 ><p
 932 >Specifying <a href="#bowtie-options-m"
 933   ><code
 934     >-m</code
 935     ></a
 936   > 5 instructs bowtie to refrain from reporting any alignments for reads having more than 5 reportable alignments. Since the read has exactly 5 reportable alignments, the <a href="#bowtie-options-m"
 937   ><code
 938     >-m</code
 939     ></a
 940   > 5 limit allows <code
 941   >bowtie</code
 942   > to print them as usual.</p
 943 ><h3 id="example-9--a--m-3---best---strata"
 944 ><a href="#TOC"
 945   >Example 9: <code
 946     >-a -m 3 --best --strata</code
 947     ></a
 948   ></h3
 949 ><pre
 950 ><code
 951   >$ ./bowtie -a -m 3 --best --strata -v 2 e_coli --suppress 1,5,6,7 -c ATGCATCATGCGCCAT
 952 -   gi|110640213|ref|NC_008253.1|   2852852 8:T&gt;A
 953 </code
 954   ></pre
 955 ><p
 956 >Specifying <a href="#bowtie-options-m"
 957   ><code
 958     >-m</code
 959     ></a
 960   > 3 instructs bowtie to refrain from reporting any alignments for reads having more than 3 reportable alignments. As we saw in Example 6, the read has only 1 reportable alignment when <a href="#bowtie-options-a"
 961   ><code
 962     >-a</code
 963     ></a
 964   >, <a href="#bowtie-options-best"
 965   ><code
 966     >--best</code
 967     ></a
 968   > and <a href="#bowtie-options-strata"
 969   ><code
 970     >--strata</code
 971     ></a
 972   > are specified, so the <a href="#bowtie-options-m"
 973   ><code
 974     >-m</code
 975     ></a
 976   > 3 limit allows <code
 977   >bowtie</code
 978   > to print that alignment as usual.</p
 979 ><p
 980 >Intuitively, the <a href="#bowtie-options-m"
 981   ><code
 982     >-m</code
 983     ></a
 984   > option, when combined with the <a href="#bowtie-options-best"
 985   ><code
 986     >--best</code
 987     ></a
 988   > and <a href="#bowtie-options-strata"
 989   ><code
 990     >--strata</code
 991     ></a
 992   > options, guarantees a principled, though weaker form of &quot;uniqueness.&quot; A stronger form of uniqueness is enforced when <a href="#bowtie-options-m"
 993   ><code
 994     >-m</code
 995     ></a
 996   > is specified but <a href="#bowtie-options-best"
 997   ><code
 998     >--best</code
 999     ></a
1000   > and <a href="#bowtie-options-strata"
1001   ><code
1002     >--strata</code
1003     ></a
1004   > are not.</p
1005 ><h2 id="paired-end-alignment"
1006 ><a href="#TOC"
1007   >Paired-end Alignment</a
1008   ></h2
1009 ><p
1010 ><code
1011   >bowtie</code
1012   > can align paired-end reads when properly paired read files are specified using the <a href="#command-line"
1013   ><code
1014     >-1</code
1015     ></a
1016   > and <a href="#command-line"
1017   ><code
1018     >-2</code
1019     ></a
1020   > options (for pairs of raw, FASTA, or FASTQ read files), or using the <a href="#command-line"
1021   ><code
1022     >--12</code
1023     ></a
1024   > option (for Tab-delimited read files). A valid paired-end alignment satisfies these criteria:</p
1025 ><ol style="list-style-type: decimal;"
1026 ><li
1027   >Both mates have a valid alignment according to the alignment policy defined by the <a href="#bowtie-options-v"
1028     ><code
1029       >-v</code
1030       ></a
1031     >/<a href="#bowtie-options-n"
1032     ><code
1033       >-n</code
1034       ></a
1035     >/<a href="#bowtie-options-e"
1036     ><code
1037       >-e</code
1038       ></a
1039     >/<a href="#bowtie-options-l"
1040     ><code
1041       >-l</code
1042       ></a
1043     > options.</li
1044   ><li
1045   >The relative orientation and position of the mates satisfy the constraints defined by the <a href="#bowtie-options-I"
1046     ><code
1047       >-I</code
1048       ></a
1049     >/<a href="#bowtie-options-X"
1050     ><code
1051       >-X</code
1052       ></a
1053     >/<a href="#bowtie-options-fr"
1054     ><code
1055       >--fr</code
1056       ></a
1057     >/<a href="#bowtie-options-fr"
1058     ><code
1059       >--rf</code
1060       ></a
1061     >/<a href="#bowtie-options-fr"
1062     ><code
1063       >--ff</code
1064       ></a
1065     > options.</li
1066   ></ol
1067 ><p
1068 >Policies governing which paired-end alignments are reported for a given read are specified using the <a href="#bowtie-options-k"
1069   ><code
1070     >-k</code
1071     ></a
1072   >, <a href="#bowtie-options-a"
1073   ><code
1074     >-a</code
1075     ></a
1076   > and <a href="#bowtie-options-m"
1077   ><code
1078     >-m</code
1079     ></a
1080   > options as usual. The <a href="#bowtie-options-strata"
1081   ><code
1082     >--strata</code
1083     ></a
1084   > and <a href="#bowtie-options-best"
1085   ><code
1086     >--best</code
1087     ></a
1088   > options do not apply in paired-end mode.</p
1089 ><p
1090 >A paired-end alignment is reported as a pair of mate alignments, both on a separate line, where the alignment for each mate is formatted the same as an unpaired (singleton) alignment. The alignment for the mate that occurs closest to the beginning of the reference sequence (the &quot;upstream&quot; mate) is always printed before the alignment for the downstream mate. Reads files containing paired-end reads will sometimes name the reads according to whether they are the #1 or #2 mates by appending a <code
1091   >/1</code
1092   > or <code
1093   >/2</code
1094   > suffix to the read name. If no such suffix is present in Bowtie's input, the suffix will be added when Bowtie prints read names in alignments (except in <a href="#bowtie-options-S"
1095   ><code
1096     >-S</code
1097     ></a
1098   > &quot;SAM&quot; mode, where mate information is encoded in the <code
1099   >FLAGS</code
1100   > field instead).</p
1101 ><p
1102 >Finding a valid paired-end alignment where both mates align to repetitive regions of the reference can be very time-consuming. By default, Bowtie avoids much of this cost by imposing a limit on the number of &quot;tries&quot; it makes to match an alignment for one mate with a nearby alignment for the other. The default limit is 100. This causes <code
1103   >bowtie</code
1104   > to miss some valid paired-end alignments where both mates lie in repetitive regions, but the user may use the <a href="#bowtie-options-pairtries"
1105   ><code
1106     >--pairtries</code
1107     ></a
1108   > or <a href="#bowtie-options-y"
1109   ><code
1110     >-y</code
1111     ></a
1112   > options to increase Bowtie's sensitivity as desired.</p
1113 ><p
1114 >Paired-end alignments where one mate's alignment is entirely contained within the other's are considered invalid.</p
1115 ><p
1116 >When colospace alignment is enabled via <a href="#bowtie-options-C"
1117   ><code
1118     >-C</code
1119     ></a
1120   >, the default setting for paired-end orientation is <a href="#bowtie-options-fr"
1121   ><code
1122     >--ff</code
1123     ></a
1124   >. This is because most SOLiD datasets have that orientation. When colorspace alignment is not enabled (default), the default setting for orientation is <a href="#bowtie-options-fr"
1125   ><code
1126     >--fr</code
1127     ></a
1128   >, since most Illumina datasets have this orientation. The default can be overriden in either case.</p
1129 ><p
1130 >Because Bowtie uses an in-memory representation of the original reference string when finding paired-end alignments, its memory footprint is larger when aligning paired-end reads. For example, the human index has a memory footprint of about 2.2 GB in single-end mode and 2.9 GB in paired-end mode. Note that paired-end and unpaired alignment incur the same memory footprint in colorspace (e.g. human incurs about 2.9 GB)</p
1131 ><h2 id="colorspace-alignment"
1132 ><a href="#TOC"
1133   >Colorspace Alignment</a
1134   ></h2
1135 ><p
1136 >As of version 0.12.0, <code
1137   >bowtie</code
1138   > can align colorspace reads against a colorspace index when <a href="#bowtie-options-C"
1139   ><code
1140     >-C</code
1141     ></a
1142   > is specified. Colorspace is the characteristic output format of Applied Biosystems' SOLiD system. In a colorspace read, each character is a color rather than a nucleotide, where a color encodes a class of dinucleotides. E.g. the color blue encodes any of the dinucleotides: AA, CC, GG, TT. Colorspace has the advantage of (often) being able to distinguish sequencing errors from SNPs once the read has been aligned. See ABI's <a href="http://tinyurl.com/ygnb2gn"
1143   >Principles of Di-Base Sequencing</a
1144   > document for details.</p
1145 ><h3 id="colorspace-reads"
1146 ><a href="#TOC"
1147   >Colorspace reads</a
1148   ></h3
1149 ><p
1150 >All input formats (FASTA <a href="#bowtie-options-f"
1151   ><code
1152     >-f</code
1153     ></a
1154   >, FASTQ <a href="#bowtie-options-q"
1155   ><code
1156     >-q</code
1157     ></a
1158   >, raw <a href="#bowtie-options-r"
1159   ><code
1160     >-r</code
1161     ></a
1162   >, tab-delimited <a href="#command-line"
1163   ><code
1164     >--12</code
1165     ></a
1166   >, command-line <a href="#bowtie-options-c"
1167   ><code
1168     >-c</code
1169     ></a
1170   >) are compatible with colorspace (<a href="#bowtie-options-C"
1171   ><code
1172     >-C</code
1173     ></a
1174   >). When <a href="#bowtie-options-C"
1175   ><code
1176     >-C</code
1177     ></a
1178   > is specified, read sequences are treated as colors. Colors may be encoded either as numbers (<code
1179   >0</code
1180   >=blue, <code
1181   >1</code
1182   >=green, <code
1183   >2</code
1184   >=orange, <code
1185   >3</code
1186   >=red) or as characters <code
1187   >A/C/G/T</code
1188   > (<code
1189   >A</code
1190   >=blue, <code
1191   >C</code
1192   >=green, <code
1193   >G</code
1194   >=orange, <code
1195   >T</code
1196   >=red).</p
1197 ><p
1198 >Some reads include a primer base as the first character; e.g.:</p
1199 ><pre
1200 ><code
1201   >&gt;1_53_33_F3
1202 T2213120002010301233221223311331
1203 &gt;1_53_70_F3
1204 T2302111203131231130300111123220
1205 ...
1206 </code
1207   ></pre
1208 ><p
1209 >Here, <code
1210   >T</code
1211   > is the primer base. <code
1212   >bowtie</code
1213   > detects and handles primer bases properly (i.e., the primer base and the adjacent color are both trimmed away prior to alignment) as long as the rest of the read is encoded as numbers.</p
1214 ><p
1215 ><code
1216   >bowtie</code
1217   > also handles input in the form of parallel <code
1218   >.csfasta</code
1219   > and <code
1220   >_QV.qual</code
1221   > files. Use <a href="#bowtie-options-f"
1222   ><code
1223     >-f</code
1224     ></a
1225   > to specify the <code
1226   >.csfasta</code
1227   > files and <a href="#bowtie-options-Q"
1228   ><code
1229     >-Q</code
1230     ></a
1231   > (for unpaired reads) or <a href="#bowtie-options-Q1"
1232   ><code
1233     >--Q1</code
1234     ></a
1235   >/<a href="#bowtie-options-Q2"
1236   ><code
1237     >--Q2</code
1238     ></a
1239   > (for paired-end reads) to specify the corresponding <code
1240   >_QV.qual</code
1241   > files. It is not necessary to first convert to FASTQ, though <code
1242   >bowtie</code
1243   > also handles FASTQ-formatted colorspace reads (with <a href="#bowtie-options-q"
1244   ><code
1245     >-q</code
1246     ></a
1247   >, the default).</p
1248 ><h3 id="building-a-colorspace-index"
1249 ><a href="#TOC"
1250   >Building a colorspace index</a
1251   ></h3
1252 ><p
1253 >A colorspace index is built in the same way as a normal index except that <a href="#bowtie-build-options-C"
1254   ><code
1255     >-C</code
1256     ></a
1257   > must be specified when running <code
1258   >bowtie-build</code
1259   >. If the user attempts to use <code
1260   >bowtie</code
1261   > without <a href="#bowtie-options-C"
1262   ><code
1263     >-C</code
1264     ></a
1265   > to align against an index that was built with <a href="#bowtie-options-C"
1266   ><code
1267     >-C</code
1268     ></a
1269   > (or vice versa), <code
1270   >bowtie</code
1271   > prints an error message and quits.</p
1272 ><h3 id="decoding-colorspace-alignments"
1273 ><a href="#TOC"
1274   >Decoding colorspace alignments</a
1275   ></h3
1276 ><p
1277 >Once a colorspace read is aligned, Bowtie decodes the alignment into nucleotides and reports the decoded nucleotide sequence. A principled decoding scheme is necessary because many different possible decodings are usually possible. Finding the true decoding with 100% certainty requires knowing all variants (e.g. SNPs) in the subject's genome beforehand, which is usually not possible. Instead, <code
1278   >bowtie</code
1279   > employs the approximate decoding scheme described in the <a href="http://bioinformatics.oxfordjournals.org/cgi/content/abstract/25/14/1754"
1280   >BWA paper</a
1281   >. This scheme attempts to distinguish variants from sequencing errors according to their relative likelihood under a model that considers the quality values of the colors and the (configurable) global likelihood of a SNP.</p
1282 ><p
1283 >Quality values are also &quot;decoded&quot; so that each reported quality value is a function of the two color qualities overlapping it. Bowtie again adopts the scheme described in the <a href="http://bioinformatics.oxfordjournals.org/cgi/content/abstract/25/14/1754"
1284   >BWA paper</a
1285   >, i.e., the decoded nucleotide quality is either the sum of the overlapping color qualities (when both overlapping colors correspond to bases that match in the alignment), the quality of the matching color minus the quality of the mismatching color, or 0 (when both overlapping colors correspond to mismatches).</p
1286 ><p
1287 >For accurate decoding, <a href="#bowtie-options-snpphred"
1288   ><code
1289     >--snpphred</code
1290     ></a
1291   >/<a href="#bowtie-options-snpfrac"
1292   ><code
1293     >--snpfrac</code
1294     ></a
1295   > should be set according to the user's best guess of the SNP frequency in the subject. The <a href="#bowtie-options-snpphred"
1296   ><code
1297     >--snpphred</code
1298     ></a
1299   > parameter sets the SNP penalty directly (on the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1300   >Phred quality</a
1301   > scale), whereas <a href="#bowtie-options-snpfrac"
1302   ><code
1303     >--snpfrac</code
1304     ></a
1305   > allows the user to specify the fraction of sites expected to be SNPs; the fraction is then converted to a <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1306   >Phred quality</a
1307   > internally. For the purpose of decoding, the SNP fraction is defined in terms of SNPs per <em
1308   >haplotype</em
1309   > base. Thus, if the genome is diploid, heterozygous SNPs have half the weight of homozygous SNPs</p
1310 ><p
1311 >Note that in <a href="#bowtie-options-S"
1312   ><code
1313     >-S</code
1314     >/<code
1315     >--sam</code
1316     ></a
1317   > mode, the decoded nucleotide sequence is printed for alignments, but the original color sequence (with <code
1318   >A</code
1319   >=blue, <code
1320   >C</code
1321   >=green, <code
1322   >G</code
1323   >=orange, <code
1324   >T</code
1325   >=red) is printed for unaligned reads without any reported alignments. As always, the <a href="#bowtie-options-un"
1326   ><code
1327     >--un</code
1328     ></a
1329   >, <a href="#bowtie-options-max"
1330   ><code
1331     >--max</code
1332     ></a
1333   > and <a href="#bowtie-options-al"
1334   ><code
1335     >--al</code
1336     ></a
1337   > parameters print reads exactly as they appeared in the input file.</p
1338 ><h3 id="paired-end-colorspace-alignment"
1339 ><a href="#TOC"
1340   >Paired-end colorspace alignment</a
1341   ></h3
1342 ><p
1343 >Like other platforms, SOLiD supports generation of paired-end reads. When colorspace alignment is enabled, the default paired-end orientation setting is <a href="#bowtie-options-fr"
1344   ><code
1345     >--ff</code
1346     ></a
1347   >. This is because most SOLiD datasets have that orientation.</p
1348 ><p
1349 >Note that SOLiD-generated read files can have &quot;orphaned&quot; mates; i.e. mates without a correpsondingly-named mate in the other file. To avoid problems due to orphaned mates, SOLiD paired-end output should first be converted to <code
1350   >.csfastq</code
1351   > files with unpaired mates omitted. This can be accomplished using, for example, [Galaxy]'s conversion tool (click &quot;NGS: QC and manipulation&quot;, then &quot;SOLiD-to-FASTQ&quot; in the left-hand sidebar).</p
1352 ><h2 id="performance-tuning"
1353 ><a href="#TOC"
1354   >Performance Tuning</a
1355   ></h2
1356 ><ol style="list-style-type: decimal;"
1357 ><li
1358   ><p
1359     >Use 64-bit bowtie if possible</p
1360     ><p
1361     >The 64-bit version of Bowtie is substantially (usually more then 50%) faster than the 32-bit version, owing to its use of 64-bit arithmetic. If possible, download the 64-bit binaries for Bowtie and run on a 64-bit computer. If you are building Bowtie from sources, you may need to pass the <code
1362       >-m64</code
1363       > option to <code
1364       >g++</code
1365       > to compile the 64-bit version; you can do this by including <code
1366       >BITS=64</code
1367       > in the arguments to the <code
1368       >make</code
1369       > command; e.g.: <code
1370       >make BITS=64 bowtie</code
1371       >. To determine whether your version of bowtie is 64-bit or 32-bit, run <code
1372       >bowtie --version</code
1373       >.</p
1374     ></li
1375   ><li
1376   ><p
1377     >If your computer has multiple processors/cores, use <code
1378       >-p</code
1379       ></p
1380     ><p
1381     >The <a href="#bowtie-options-p"
1382       ><code
1383         >-p</code
1384         ></a
1385       > option causes Bowtie to launch a specified number of parallel search threads. Each thread runs on a different processor/core and all threads find alignments in parallel, increasing alignment throughput by approximately a multiple of the number of threads (though in practice, speedup is somewhat worse than linear).</p
1386     ></li
1387   ><li
1388   ><p
1389     >If reporting many alignments per read, try tweaking <code
1390       >bowtie-build --offrate</code
1391       ></p
1392     ><p
1393     >If you are using the <a href="#bowtie-options-k"
1394       ><code
1395         >-k</code
1396         ></a
1397       >, <a href="#bowtie-options-a"
1398       ><code
1399         >-a</code
1400         ></a
1401       > or <a href="#bowtie-options-m"
1402       ><code
1403         >-m</code
1404         ></a
1405       > options and Bowtie is reporting many alignments per read (an average of more than about 10 per read) and you have some memory to spare, using an index with a denser SA sample can speed things up considerably.</p
1406     ><p
1407     >To do this, specify a smaller-than-default <a href="#bowtie-build-options-o"
1408       ><code
1409         >-o</code
1410         >/<code
1411         >--offrate</code
1412         ></a
1413       > value when running <code
1414       >bowtie-build</code
1415       >. A denser SA sample yields a larger index, but is also particularly effective at speeding up alignment when many alignments are reported per read. For example, decreasing the index's <a href="#bowtie-build-options-o"
1416       ><code
1417         >-o</code
1418         >/<code
1419         >--offrate</code
1420         ></a
1421       > by 1 could as much as double alignment performance, and decreasing by 2 could quadruple alignment performance, etc.</p
1422     ><p
1423     >On the other hand, decreasing <a href="#bowtie-build-options-o"
1424       ><code
1425         >-o</code
1426         >/<code
1427         >--offrate</code
1428         ></a
1429       > increases the size of the Bowtie index, both on disk and in memory when aligning reads. At the default <a href="#bowtie-build-options-o"
1430       ><code
1431         >-o</code
1432         >/<code
1433         >--offrate</code
1434         ></a
1435       > of 5, the SA sample for the human genome occupies about 375 MB of memory when aligning reads. Decreasing the <a href="#bowtie-build-options-o"
1436       ><code
1437         >-o</code
1438         >/<code
1439         >--offrate</code
1440         ></a
1441       > by 1 doubles the memory taken by the SA sample, and decreasing by 2 quadruples the memory taken, etc.</p
1442     ></li
1443   ><li
1444   ><p
1445     >If bowtie &quot;thrashes&quot;, try increasing <code
1446       >bowtie --offrate</code
1447       ></p
1448     ><p
1449     >If <code
1450       >bowtie</code
1451       > runs very slow on a relatively low-memory machine (having less than about 4 GB of memory), then try setting <code
1452       >bowtie</code
1453       > <a href="#bowtie-options-o"
1454       ><code
1455         >-o</code
1456         >/<code
1457         >--offrate</code
1458         ></a
1459       > to a <em
1460       >larger</em
1461       > value than the value used to build the index. For example, <code
1462       >bowtie-build</code
1463       >'s default <a href="#bowtie-build-options-o"
1464       ><code
1465         >-o</code
1466         >/<code
1467         >--offrate</code
1468         ></a
1469       > is 5 and all pre-built indexes available from the Bowtie website are built with <a href="#bowtie-build-options-o"
1470       ><code
1471         >-o</code
1472         >/<code
1473         >--offrate</code
1474         ></a
1475       > 5; so if <code
1476       >bowtie</code
1477       > thrashes when querying such an index, try using <code
1478       >bowtie</code
1479       > <a href="#bowtie-options-o"
1480       ><code
1481         >--offrate</code
1482         ></a
1483       > 6. If <code
1484       >bowtie</code
1485       > still thrashes, try <code
1486       >bowtie</code
1487       > <a href="#bowtie-options-o"
1488       ><code
1489         >--offrate</code
1490         ></a
1491       > 7, etc. A higher <a href="#bowtie-options-o"
1492       ><code
1493         >-o</code
1494         >/<code
1495         >--offrate</code
1496         ></a
1497       > causes <code
1498       >bowtie</code
1499       > to use a sparser sample of the suffix array than is stored in the index; this saves memory but makes alignment reporting slower (which is especially slow when using <a href="#bowtie-options-a"
1500       ><code
1501         >-a</code
1502         ></a
1503       > or large <a href="#bowtie-options-k"
1504       ><code
1505         >-k</code
1506         ></a
1507       > or <a href="#bowtie-options-m"
1508       ><code
1509         >-m</code
1510         ></a
1511       >).</p
1512     ></li
1513   ></ol
1514 ><h2 id="command-line"
1515 ><a href="#TOC"
1516   >Command Line</a
1517   ></h2
1518 ><p
1519 >Usage:</p
1520 ><pre
1521 ><code
1522   >bowtie [options]* &lt;ebwt&gt; {-1 &lt;m1&gt; -2 &lt;m2&gt; | --12 &lt;r&gt; | &lt;s&gt;} [&lt;hit&gt;]
1523 </code
1524   ></pre
1525 ><h3 id="main-arguments"
1526 ><a href="#TOC"
1527   >Main arguments</a
1528   ></h3
1529 ><table><tr><td>
1530 <pre
1531 ><code
1532   >&lt;ebwt&gt;
1533 </code
1534   ></pre
1535 ></td><td>
1536 <p
1537 >The basename of the index to be searched. The basename is the name of any of the index files up to but not including the final <code
1538   >.1.ebwt</code
1539   > / <code
1540   >.rev.1.ebwt</code
1541   > / etc. <code
1542   >bowtie</code
1543   > looks for the specified index first in the current directory, then in the <code
1544   >indexes</code
1545   > subdirectory under the directory where the <code
1546   >bowtie</code
1547   > executable is located, then looks in the directory specified in the <code
1548   >BOWTIE_INDEXES</code
1549   > environment variable.</p
1550 ></td></tr><tr><td>
1551 <pre
1552 ><code
1553   >&lt;m1&gt;
1554 </code
1555   ></pre
1556 ></td><td>
1557 <p
1558 >Comma-separated list of files containing the #1 mates (filename usually includes <code
1559   >_1</code
1560   >), or, if <a href="#bowtie-options-c"
1561   ><code
1562     >-c</code
1563     ></a
1564   > is specified, the mate sequences themselves. E.g., this might be <code
1565   >flyA_1.fq,flyB_1.fq</code
1566   >, or, if <a href="#bowtie-options-c"
1567   ><code
1568     >-c</code
1569     ></a
1570   > is specified, this might be <code
1571   >GGTCATCCT,ACGGGTCGT</code
1572   >. Sequences specified with this option must correspond file-for-file and read-for-read with those specified in <code
1573   >&lt;m2&gt;</code
1574   >. Reads may be a mix of different lengths. If <code
1575   >-</code
1576   > is specified, <code
1577   >bowtie</code
1578   > will read the #1 mates from the &quot;standard in&quot; filehandle.</p
1579 ></td></tr><tr><td>
1580 <pre
1581 ><code
1582   >&lt;m2&gt;
1583 </code
1584   ></pre
1585 ></td><td>
1586 <p
1587 >Comma-separated list of files containing the #2 mates (filename usually includes <code
1588   >_2</code
1589   >), or, if <a href="#bowtie-options-c"
1590   ><code
1591     >-c</code
1592     ></a
1593   > is specified, the mate sequences themselves. E.g., this might be <code
1594   >flyA_2.fq,flyB_2.fq</code
1595   >, or, if <a href="#bowtie-options-c"
1596   ><code
1597     >-c</code
1598     ></a
1599   > is specified, this might be <code
1600   >GGTCATCCT,ACGGGTCGT</code
1601   >. Sequences specified with this option must correspond file-for-file and read-for-read with those specified in <code
1602   >&lt;m1&gt;</code
1603   >. Reads may be a mix of different lengths. If <code
1604   >-</code
1605   > is specified, <code
1606   >bowtie</code
1607   > will read the #2 mates from the &quot;standard in&quot; filehandle.</p
1608 ></td></tr><tr><td>
1609 <pre
1610 ><code
1611   >&lt;r&gt;
1612 </code
1613   ></pre
1614 ></td><td>
1615 <p
1616 >Comma-separated list of files containing a mix of unpaired and paired-end reads in Tab-delimited format. Tab-delimited format is a 1-read-per-line format where unpaired reads consist of a read name, sequence and quality string each separated by tabs. A paired-end read consists of a read name, sequnce of the #1 mate, quality values of the #1 mate, sequence of the #2 mate, and quality values of the #2 mate separated by tabs. Quality values can be expressed using any of the scales supported in FASTQ files. Reads may be a mix of different lengths and paired-end and unpaired reads may be intermingled in the same file. If <code
1617   >-</code
1618   > is specified, <code
1619   >bowtie</code
1620   > will read the Tab-delimited reads from the &quot;standard in&quot; filehandle.</p
1621 ></td></tr><tr><td>
1622 <pre
1623 ><code
1624   >&lt;s&gt;
1625 </code
1626   ></pre
1627 ></td><td>
1628 <p
1629 >A comma-separated list of files containing unpaired reads to be aligned, or, if <a href="#bowtie-options-c"
1630   ><code
1631     >-c</code
1632     ></a
1633   > is specified, the unpaired read sequences themselves. E.g., this might be <code
1634   >lane1.fq,lane2.fq,lane3.fq,lane4.fq</code
1635   >, or, if <a href="#bowtie-options-c"
1636   ><code
1637     >-c</code
1638     ></a
1639   > is specified, this might be <code
1640   >GGTCATCCT,ACGGGTCGT</code
1641   >. Reads may be a mix of different lengths. If <code
1642   >-</code
1643   > is specified, Bowtie gets the reads from the &quot;standard in&quot; filehandle.</p
1644 ></td></tr><tr><td>
1645 <pre
1646 ><code
1647   >&lt;hit&gt;
1648 </code
1649   ></pre
1650 ></td><td>
1651 <p
1652 >File to write alignments to. By default, alignments are written to the &quot;standard out&quot; filehandle (i.e. the console).</p
1653 ></td></tr></table>
1654 <h3 id="options"
1655 ><a href="#TOC"
1656   >Options</a
1657   ></h3
1658 ><h4 id="input"
1659 ><a href="#TOC"
1660   >Input</a
1661   ></h4
1662 ><table>
1663 <tr><td id="bowtie-options-q">
1664
1665
1666 <pre
1667 ><code
1668   >-q
1669 </code
1670   ></pre
1671 ></td><td>
1672 <p
1673 >The query input files (specified either as <code
1674   >&lt;m1&gt;</code
1675   > and <code
1676   >&lt;m2&gt;</code
1677   >, or as <code
1678   >&lt;s&gt;</code
1679   >) are FASTQ files (usually having extension <code
1680   >.fq</code
1681   > or <code
1682   >.fastq</code
1683   >). This is the default. See also: <a href="#bowtie-options-solexa-quals"
1684   ><code
1685     >--solexa-quals</code
1686     ></a
1687   > and <a href="#bowtie-options-integer-quals"
1688   ><code
1689     >--integer-quals</code
1690     ></a
1691   >.</p
1692 ></td></tr><tr><td id="bowtie-options-f">
1693
1694
1695 <pre
1696 ><code
1697   >-f
1698 </code
1699   ></pre
1700 ></td><td>
1701 <p
1702 >The query input files (specified either as <code
1703   >&lt;m1&gt;</code
1704   > and <code
1705   >&lt;m2&gt;</code
1706   >, or as <code
1707   >&lt;s&gt;</code
1708   >) are FASTA files (usually having extension <code
1709   >.fa</code
1710   >, <code
1711   >.mfa</code
1712   >, <code
1713   >.fna</code
1714   > or similar). All quality values are assumed to be 40 on the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1715   >Phred quality</a
1716   > scale.</p
1717 ></td></tr><tr><td id="bowtie-options-r">
1718
1719
1720 <pre
1721 ><code
1722   >-r
1723 </code
1724   ></pre
1725 ></td><td>
1726 <p
1727 >The query input files (specified either as <code
1728   >&lt;m1&gt;</code
1729   > and <code
1730   >&lt;m2&gt;</code
1731   >, or as <code
1732   >&lt;s&gt;</code
1733   >) are Raw files: one sequence per line, without quality values or names. All quality values are assumed to be 40 on the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1734   >Phred quality</a
1735   > scale.</p
1736 ></td></tr><tr><td id="bowtie-options-c">
1737
1738
1739 <pre
1740 ><code
1741   >-c
1742 </code
1743   ></pre
1744 ></td><td>
1745 <p
1746 >The query sequences are given on command line. I.e. <code
1747   >&lt;m1&gt;</code
1748   >, <code
1749   >&lt;m2&gt;</code
1750   > and <code
1751   >&lt;singles&gt;</code
1752   > are comma-separated lists of reads rather than lists of read files.</p
1753 ></td></tr><tr><td id="bowtie-options-C">
1754
1755
1756
1757 <pre
1758 ><code
1759   >-C/--color
1760 </code
1761   ></pre
1762 ></td><td>
1763 <p
1764 >Align in colorspace. Read characters are interpreted as colors. The index specified must be a colorspace index (i.e. built with <code
1765   >bowtie-build</code
1766   > <a href="#bowtie-build-options-C"
1767   ><code
1768     >-C</code
1769     ></a
1770   >, or <code
1771   >bowtie</code
1772   > will print an error message and quit. See <a href="#colorspace-alignment"
1773   >Colorspace alignment</a
1774   > for more details.</p
1775 ></td></tr><tr><td id="bowtie-options-Q">
1776
1777
1778
1779 <pre
1780 ><code
1781   >-Q/--quals &lt;files&gt;
1782 </code
1783   ></pre
1784 ></td><td>
1785 <p
1786 >Comma-separated list of files containing quality values for corresponding unpaired CSFASTA reads. Use in combination with <a href="#bowtie-options-C"
1787   ><code
1788     >-C</code
1789     ></a
1790   > and <a href="#bowtie-options-f"
1791   ><code
1792     >-f</code
1793     ></a
1794   >. <a href="#bowtie-options-integer-quals"
1795   ><code
1796     >--integer-quals</code
1797     ></a
1798   > is set automatically when <code
1799   >-Q</code
1800   >/<code
1801   >--quals</code
1802   > is specified.</p
1803 ></td></tr><tr><td id="bowtie-options-Q1">
1804
1805
1806 <pre
1807 ><code
1808   >--Q1 &lt;files&gt;
1809 </code
1810   ></pre
1811 ></td><td>
1812 <p
1813 >Comma-separated list of files containing quality values for corresponding CSFASTA #1 mates. Use in combination with <a href="#bowtie-options-C"
1814   ><code
1815     >-C</code
1816     ></a
1817   >, <a href="#bowtie-options-f"
1818   ><code
1819     >-f</code
1820     ></a
1821   >, and <a href="#command-line"
1822   ><code
1823     >-1</code
1824     ></a
1825   >. <a href="#bowtie-options-integer-quals"
1826   ><code
1827     >--integer-quals</code
1828     ></a
1829   > is set automatically when <code
1830   >--Q1</code
1831   > is specified.</p
1832 ></td></tr><tr><td id="bowtie-options-Q2">
1833
1834
1835 <pre
1836 ><code
1837   >--Q2 &lt;files&gt;
1838 </code
1839   ></pre
1840 ></td><td>
1841 <p
1842 >Comma-separated list of files containing quality values for corresponding CSFASTA #2 mates. Use in combination with <a href="#bowtie-options-C"
1843   ><code
1844     >-C</code
1845     ></a
1846   >, <a href="#bowtie-options-f"
1847   ><code
1848     >-f</code
1849     ></a
1850   >, and <a href="#command-line"
1851   ><code
1852     >-2</code
1853     ></a
1854   >. <a href="#bowtie-options-integer-quals"
1855   ><code
1856     >--integer-quals</code
1857     ></a
1858   > is set automatically when <code
1859   >--Q2</code
1860   > is specified.</p
1861 ></td></tr><tr><td id="bowtie-options-s">
1862
1863
1864
1865 <pre
1866 ><code
1867   >-s/--skip &lt;int&gt;
1868 </code
1869   ></pre
1870 ></td><td>
1871 <p
1872 >Skip (i.e. do not align) the first <code
1873   >&lt;int&gt;</code
1874   > reads or pairs in the input.</p
1875 ></td></tr><tr><td id="bowtie-options-u">
1876
1877
1878
1879 <pre
1880 ><code
1881   >-u/--qupto &lt;int&gt;
1882 </code
1883   ></pre
1884 ></td><td>
1885 <p
1886 >Only align the first <code
1887   >&lt;int&gt;</code
1888   > reads or read pairs from the input (after the <a href="#bowtie-options-s"
1889   ><code
1890     >-s</code
1891     >/<code
1892     >--skip</code
1893     ></a
1894   > reads or pairs have been skipped). Default: no limit.</p
1895 ></td></tr><tr><td id="bowtie-options-5">
1896
1897
1898
1899 <pre
1900 ><code
1901   >-5/--trim5 &lt;int&gt;
1902 </code
1903   ></pre
1904 ></td><td>
1905 <p
1906 >Trim <code
1907   >&lt;int&gt;</code
1908   > bases from high-quality (left) end of each read before alignment (default: 0).</p
1909 ></td></tr><tr><td id="bowtie-options-3">
1910
1911
1912
1913 <pre
1914 ><code
1915   >-3/--trim3 &lt;int&gt;
1916 </code
1917   ></pre
1918 ></td><td>
1919 <p
1920 >Trim <code
1921   >&lt;int&gt;</code
1922   > bases from low-quality (right) end of each read before alignment (default: 0).</p
1923 ></td></tr><tr><td id="bowtie-options-phred33-quals">
1924
1925
1926 <pre
1927 ><code
1928   >--phred33-quals
1929 </code
1930   ></pre
1931 ></td><td>
1932 <p
1933 >Input qualities are ASCII chars equal to the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1934   >Phred quality</a
1935   > plus 33. Default: on.</p
1936 ></td></tr><tr><td id="bowtie-options-phred64-quals">
1937
1938
1939 <pre
1940 ><code
1941   >--phred64-quals
1942 </code
1943   ></pre
1944 ></td><td>
1945 <p
1946 >Input qualities are ASCII chars equal to the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1947   >Phred quality</a
1948   > plus 64. Default: off.</p
1949 ></td></tr><tr><td id="bowtie-options-solexa-quals">
1950
1951
1952 <pre
1953 ><code
1954   >--solexa-quals
1955 </code
1956   ></pre
1957 ></td><td>
1958 <p
1959 >Convert input qualities from <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1960   >Solexa</a
1961   > (which can be negative) to <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1962   >Phred</a
1963   > (which can't). This is usually the right option for use with (unconverted) reads emitted by GA Pipeline versions prior to 1.3. Default: off.</p
1964 ></td></tr><tr><td id="bowtie-options-solexa1.3-quals">
1965
1966
1967 <pre
1968 ><code
1969   >--solexa1.3-quals
1970 </code
1971   ></pre
1972 ></td><td>
1973 <p
1974 >Same as <a href="#bowtie-options-phred64-quals"
1975   ><code
1976     >--phred64-quals</code
1977     ></a
1978   >. This is usually the right option for use with (unconverted) reads emitted by GA Pipeline version 1.3 or later. Default: off.</p
1979 ></td></tr><tr><td id="bowtie-options-integer-quals">
1980
1981
1982 <pre
1983 ><code
1984   >--integer-quals
1985 </code
1986   ></pre
1987 ></td><td>
1988 <p
1989 >Quality values are represented in the read input file as space-separated ASCII integers, e.g., <code
1990   >40 40 30 40</code
1991   >..., rather than ASCII characters, e.g., <code
1992   >II?I</code
1993   >.... Integers are treated as being on the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
1994   >Phred quality</a
1995   > scale unless <a href="#bowtie-options-solexa-quals"
1996   ><code
1997     >--solexa-quals</code
1998     ></a
1999   > is also specified. Default: off.</p
2000 ></td></tr></table>
2001 <h4 id="alignment"
2002 ><a href="#TOC"
2003   >Alignment</a
2004   ></h4
2005 ><table>
2006
2007 <tr><td id="bowtie-options-v">
2008
2009
2010 <pre
2011 ><code
2012   >-v &lt;int&gt;
2013 </code
2014   ></pre
2015 ></td><td>
2016 <p
2017 >Report alignments with at most <code
2018   >&lt;int&gt;</code
2019   > mismatches. <a href="#bowtie-options-e"
2020   ><code
2021     >-e</code
2022     ></a
2023   > and <a href="#bowtie-options-l"
2024   ><code
2025     >-l</code
2026     ></a
2027   > options are ignored and quality values have no effect on what alignments are valid. <a href="#bowtie-options-v"
2028   ><code
2029     >-v</code
2030     ></a
2031   > is mutually exclusive with <a href="#bowtie-options-n"
2032   ><code
2033     >-n</code
2034     ></a
2035   >.</p
2036 ></td></tr><tr><td id="bowtie-options-n">
2037
2038
2039
2040 <pre
2041 ><code
2042   >-n/--seedmms &lt;int&gt;
2043 </code
2044   ></pre
2045 ></td><td>
2046 <p
2047 >Maximum number of mismatches permitted in the &quot;seed&quot;, i.e. the first <code
2048   >L</code
2049   > base pairs of the read (where <code
2050   >L</code
2051   > is set with <a href="#bowtie-options-l"
2052   ><code
2053     >-l</code
2054     >/<code
2055     >--seedlen</code
2056     ></a
2057   >). This may be 0, 1, 2 or 3 and the default is 2. This option is mutually exclusive with the <a href="#bowtie-options-v"
2058   ><code
2059     >-v</code
2060     ></a
2061   > option.</p
2062 ></td></tr><tr><td id="bowtie-options-e">
2063
2064
2065
2066 <pre
2067 ><code
2068   >-e/--maqerr &lt;int&gt;
2069 </code
2070   ></pre
2071 ></td><td>
2072 <p
2073 >Maximum permitted total of quality values at <em
2074   >all</em
2075   > mismatched read positions throughout the entire alignment, not just in the &quot;seed&quot;. The default is 70. Like <a href="http://maq.sf.net"
2076   >Maq</a
2077   >, <code
2078   >bowtie</code
2079   > rounds quality values to the nearest 10 and saturates at 30; rounding can be disabled with <a href="#bowtie-options-nomaqround"
2080   ><code
2081     >--nomaqround</code
2082     ></a
2083   >.</p
2084 ></td></tr><tr><td id="bowtie-options-l">
2085
2086
2087
2088 <pre
2089 ><code
2090   >-l/--seedlen &lt;int&gt;
2091 </code
2092   ></pre
2093 ></td><td>
2094 <p
2095 >The &quot;seed length&quot;; i.e., the number of bases on the high-quality end of the read to which the <a href="#bowtie-options-n"
2096   ><code
2097     >-n</code
2098     ></a
2099   > ceiling applies. The lowest permitted setting is 5 and the default is 28. <code
2100   >bowtie</code
2101   > is faster for larger values of <a href="#bowtie-options-l"
2102   ><code
2103     >-l</code
2104     ></a
2105   >.</p
2106 ></td></tr><tr><td id="bowtie-options-nomaqround">
2107
2108
2109 <pre
2110 ><code
2111   >--nomaqround
2112 </code
2113   ></pre
2114 ></td><td>
2115 <p
2116 ><a href="http://maq.sf.net"
2117   >Maq</a
2118   > accepts quality values in the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
2119   >Phred quality</a
2120   > scale, but internally rounds values to the nearest 10, with a maximum of 30. By default, <code
2121   >bowtie</code
2122   > also rounds this way. <a href="#bowtie-options-nomaqround"
2123   ><code
2124     >--nomaqround</code
2125     ></a
2126   > prevents this rounding in <code
2127   >bowtie</code
2128   >.</p
2129 ></td></tr><tr><td id="bowtie-options-I">
2130
2131
2132
2133 <pre
2134 ><code
2135   >-I/--minins &lt;int&gt;
2136 </code
2137   ></pre
2138 ></td><td>
2139 <p
2140 >The minimum insert size for valid paired-end alignments. E.g. if <code
2141   >-I 60</code
2142   > is specified and a paired-end alignment consists of two 20-bp alignments in the appropriate orientation with a 20-bp gap between them, that alignment is considered valid (as long as <a href="#bowtie-options-X"
2143   ><code
2144     >-X</code
2145     ></a
2146   > is also satisfied). A 19-bp gap would not be valid in that case. If trimming options <a href="#bowtie-options-3"
2147   ><code
2148     >-3</code
2149     ></a
2150   > or <a href="#bowtie-options-5"
2151   ><code
2152     >-5</code
2153     ></a
2154   > are also used, the <a href="#bowtie-options-I"
2155   ><code
2156     >-I</code
2157     ></a
2158   > constraint is applied with respect to the untrimmed mates. Default: 0.</p
2159 ></td></tr><tr><td id="bowtie-options-X">
2160
2161
2162
2163 <pre
2164 ><code
2165   >-X/--maxins &lt;int&gt;
2166 </code
2167   ></pre
2168 ></td><td>
2169 <p
2170 >The maximum insert size for valid paired-end alignments. E.g. if <code
2171   >-X 100</code
2172   > is specified and a paired-end alignment consists of two 20-bp alignments in the proper orientation with a 60-bp gap between them, that alignment is considered valid (as long as <a href="#bowtie-options-I"
2173   ><code
2174     >-I</code
2175     ></a
2176   > is also satisfied). A 61-bp gap would not be valid in that case. If trimming options <a href="#bowtie-options-3"
2177   ><code
2178     >-3</code
2179     ></a
2180   > or <a href="#bowtie-options-5"
2181   ><code
2182     >-5</code
2183     ></a
2184   > are also used, the <code
2185   >-X</code
2186   > constraint is applied with respect to the untrimmed mates, not the trimmed mates. Default: 250.</p
2187 ></td></tr><tr><td id="bowtie-options-fr">
2188
2189
2190
2191
2192
2193 <pre
2194 ><code
2195   >--fr/--rf/--ff
2196 </code
2197   ></pre
2198 ></td><td>
2199 <p
2200 >The upstream/downstream mate orientations for a valid paired-end alignment against the forward reference strand. E.g., if <code
2201   >--fr</code
2202   > is specified and there is a candidate paired-end alignment where mate1 appears upstream of the reverse complement of mate2 and the insert length constraints are met, that alignment is valid. Also, if mate2 appears upstream of the reverse complement of mate1 and all other constraints are met, that too is valid. <code
2203   >--rf</code
2204   > likewise requires that an upstream mate1 be reverse-complemented and a downstream mate2 be forward-oriented. <code
2205   >--ff</code
2206   > requires both an upstream mate1 and a downstream mate2 to be forward-oriented. Default: <code
2207   >--fr</code
2208   > when <a href="#bowtie-options-C"
2209   ><code
2210     >-C</code
2211     ></a
2212   > (colorspace alignment) is not specified, <code
2213   >--ff</code
2214   > when <a href="#bowtie-options-C"
2215   ><code
2216     >-C</code
2217     ></a
2218   > is specified.</p
2219 ></td></tr><tr><td id="bowtie-options-nofw">
2220
2221
2222 <pre
2223 ><code
2224   >--nofw/--norc
2225 </code
2226   ></pre
2227 ></td><td>
2228 <p
2229 >If <code
2230   >--nofw</code
2231   > is specified, <code
2232   >bowtie</code
2233   > will not attempt to align against the forward reference strand. If <code
2234   >--norc</code
2235   > is specified, <code
2236   >bowtie</code
2237   > will not attempt to align against the reverse-complement reference strand. For paired-end reads using <a href="#bowtie-options-fr"
2238   ><code
2239     >--fr</code
2240     ></a
2241   > or <a href="#bowtie-options-fr"
2242   ><code
2243     >--rf</code
2244     ></a
2245   > modes, <code
2246   >--nofw</code
2247   > and <code
2248   >--norc</code
2249   > apply to the forward and reverse-complement pair orientations. I.e. specifying <code
2250   >--nofw</code
2251   > and <a href="#bowtie-options-fr"
2252   ><code
2253     >--fr</code
2254     ></a
2255   > will only find reads in the R/F orientation where mate 2 occurs upstream of mate 1 with respect to the forward reference strand.</p
2256 ></td></tr><tr><td id="bowtie-options-maxbts">
2257
2258
2259 <pre
2260 ><code
2261   >--maxbts
2262 </code
2263   ></pre
2264 ></td><td>
2265 <p
2266 >The maximum number of backtracks permitted when aligning a read in <a href="#bowtie-options-n"
2267   ><code
2268     >-n</code
2269     ></a
2270   > 2 or <a href="#bowtie-options-n"
2271   ><code
2272     >-n</code
2273     ></a
2274   > 3 mode (default: 125 without <a href="#bowtie-options-best"
2275   ><code
2276     >--best</code
2277     ></a
2278   >, 800 with <a href="#bowtie-options-best"
2279   ><code
2280     >--best</code
2281     ></a
2282   >). A &quot;backtrack&quot; is the introduction of a speculative substitution into the alignment. Without this limit, the default parameters will sometimes require that <code
2283   >bowtie</code
2284   > try 100s or 1,000s of backtracks to align a read, especially if the read has many low-quality bases and/or has no valid alignments, slowing bowtie down significantly. However, this limit may cause some valid alignments to be missed. Higher limits yield greater sensitivity at the expensive of longer running times. See also: <a href="#bowtie-options-y"
2285   ><code
2286     >-y</code
2287     >/<code
2288     >--tryhard</code
2289     ></a
2290   >.</p
2291 ></td></tr><tr><td id="bowtie-options-pairtries">
2292
2293
2294 <pre
2295 ><code
2296   >--pairtries &lt;int&gt;
2297 </code
2298   ></pre
2299 ></td><td>
2300 <p
2301 >For paired-end alignment, this is the maximum number of attempts <code
2302   >bowtie</code
2303   > will make to match an alignment for one mate up with an alignment for the opposite mate. Most paired-end alignments require only a few such attempts, but pairs where both mates occur in highly repetitive regions of the reference can require significantly more. Setting this to a higher number allows <code
2304   >bowtie</code
2305   > to find more paired- end alignments for repetitive pairs at the expense of speed. The default is 100. See also: <a href="#bowtie-options-y"
2306   ><code
2307     >-y</code
2308     >/<code
2309     >--tryhard</code
2310     ></a
2311   >.</p
2312 ></td></tr><tr><td id="bowtie-options-y">
2313
2314
2315
2316 <pre
2317 ><code
2318   >-y/--tryhard
2319 </code
2320   ></pre
2321 ></td><td>
2322 <p
2323 >Try as hard as possible to find valid alignments when they exist, including paired-end alignments. This is equivalent to specifying very high values for the <a href="#bowtie-options-maxbts"
2324   ><code
2325     >--maxbts</code
2326     ></a
2327   > and <a href="#bowtie-options-pairtries"
2328   ><code
2329     >--pairtries</code
2330     ></a
2331   > options. This mode is generally much slower than the default settings, but can be useful for certain problems. This mode is slower when (a) the reference is very repetitive, (b) the reads are low quality, or (c) not many reads have valid alignments.</p
2332 ></td></tr><tr><td id="bowtie-options-chunkmbs">
2333
2334
2335 <pre
2336 ><code
2337   >--chunkmbs &lt;int&gt;
2338 </code
2339   ></pre
2340 ></td><td>
2341 <p
2342 >The number of megabytes of memory a given thread is given to store path descriptors in <a href="#bowtie-options-best"
2343   ><code
2344     >--best</code
2345     ></a
2346   > mode. Best-first search must keep track of many paths at once to ensure it is always extending the path with the lowest cumulative cost. Bowtie tries to minimize the memory impact of the descriptors, but they can still grow very large in some cases. If you receive an error message saying that chunk memory has been exhausted in <a href="#bowtie-options-best"
2347   ><code
2348     >--best</code
2349     ></a
2350   > mode, try adjusting this parameter up to dedicate more memory to the descriptors. Default: 64.</p
2351 ></td></tr></table>
2352 <h4 id="reporting"
2353 ><a href="#TOC"
2354   >Reporting</a
2355   ></h4
2356 ><table><tr><td id="bowtie-options-k">
2357
2358
2359 <pre
2360 ><code
2361   >-k &lt;int&gt;
2362 </code
2363   ></pre
2364 ></td><td>
2365 <p
2366 >Report up to <code
2367   >&lt;int&gt;</code
2368   > valid alignments per read or pair (default: 1). Validity of alignments is determined by the alignment policy (combined effects of <a href="#bowtie-options-n"
2369   ><code
2370     >-n</code
2371     ></a
2372   >, <a href="#bowtie-options-v"
2373   ><code
2374     >-v</code
2375     ></a
2376   >, <a href="#bowtie-options-l"
2377   ><code
2378     >-l</code
2379     ></a
2380   >, and <a href="#bowtie-options-e"
2381   ><code
2382     >-e</code
2383     ></a
2384   >). If more than one valid alignment exists and the <a href="#bowtie-options-best"
2385   ><code
2386     >--best</code
2387     ></a
2388   > and <a href="#bowtie-options-strata"
2389   ><code
2390     >--strata</code
2391     ></a
2392   > options are specified, then only those alignments belonging to the best alignment &quot;stratum&quot; will be reported. Bowtie is designed to be very fast for small <a href="#bowtie-options-k"
2393   ><code
2394     >-k</code
2395     ></a
2396   > but bowtie can become significantly slower as <a href="#bowtie-options-k"
2397   ><code
2398     >-k</code
2399     ></a
2400   > increases. If you would like to use Bowtie for larger values of <a href="#bowtie-options-k"
2401   ><code
2402     >-k</code
2403     ></a
2404   >, consider building an index with a denser suffix-array sample, i.e. specify a smaller <a href="#bowtie-build-options-o"
2405   ><code
2406     >-o</code
2407     >/<code
2408     >--offrate</code
2409     ></a
2410   > when invoking <code
2411   >bowtie-build</code
2412   > for the relevant index (see the <a href="#performance-tuning"
2413   >Performance tuning</a
2414   > section for details).</p
2415 ></td></tr><tr><td id="bowtie-options-a">
2416
2417
2418
2419 <pre
2420 ><code
2421   >-a/--all
2422 </code
2423   ></pre
2424 ></td><td>
2425 <p
2426 >Report all valid alignments per read or pair (default: off). Validity of alignments is determined by the alignment policy (combined effects of <a href="#bowtie-options-n"
2427   ><code
2428     >-n</code
2429     ></a
2430   >, <a href="#bowtie-options-v"
2431   ><code
2432     >-v</code
2433     ></a
2434   >, <a href="#bowtie-options-l"
2435   ><code
2436     >-l</code
2437     ></a
2438   >, and <a href="#bowtie-options-e"
2439   ><code
2440     >-e</code
2441     ></a
2442   >). If more than one valid alignment exists and the <a href="#bowtie-options-best"
2443   ><code
2444     >--best</code
2445     ></a
2446   > and <a href="#bowtie-options-strata"
2447   ><code
2448     >--strata</code
2449     ></a
2450   > options are specified, then only those alignments belonging to the best alignment &quot;stratum&quot; will be reported. Bowtie is designed to be very fast for small <a href="#bowtie-options-k"
2451   ><code
2452     >-k</code
2453     ></a
2454   > but bowtie can become significantly slower if <a href="#bowtie-options-a"
2455   ><code
2456     >-a</code
2457     >/<code
2458     >--all</code
2459     ></a
2460   > is specified. If you would like to use Bowtie with <a href="#bowtie-options-a"
2461   ><code
2462     >-a</code
2463     ></a
2464   >, consider building an index with a denser suffix-array sample, i.e. specify a smaller <a href="#bowtie-build-options-o"
2465   ><code
2466     >-o</code
2467     >/<code
2468     >--offrate</code
2469     ></a
2470   > when invoking <code
2471   >bowtie-build</code
2472   > for the relevant index (see the <a href="#performance-tuning"
2473   >Performance tuning</a
2474   > section for details).</p
2475 ></td></tr><tr><td id="bowtie-options-m">
2476
2477
2478 <pre
2479 ><code
2480   >-m &lt;int&gt;
2481 </code
2482   ></pre
2483 ></td><td>
2484 <p
2485 >Suppress all alignments for a particular read or pair if more than <code
2486   >&lt;int&gt;</code
2487   > reportable alignments exist for it. Reportable alignments are those that would be reported given the <a href="#bowtie-options-n"
2488   ><code
2489     >-n</code
2490     ></a
2491   >, <a href="#bowtie-options-v"
2492   ><code
2493     >-v</code
2494     ></a
2495   >, <a href="#bowtie-options-l"
2496   ><code
2497     >-l</code
2498     ></a
2499   >, <a href="#bowtie-options-e"
2500   ><code
2501     >-e</code
2502     ></a
2503   >, <a href="#bowtie-options-k"
2504   ><code
2505     >-k</code
2506     ></a
2507   >, <a href="#bowtie-options-a"
2508   ><code
2509     >-a</code
2510     ></a
2511   >, <a href="#bowtie-options-best"
2512   ><code
2513     >--best</code
2514     ></a
2515   >, and <a href="#bowtie-options-strata"
2516   ><code
2517     >--strata</code
2518     ></a
2519   > options. Default: no limit. Bowtie is designed to be very fast for small <a href="#bowtie-options-m"
2520   ><code
2521     >-m</code
2522     ></a
2523   > but bowtie can become significantly slower for larger values of <a href="#bowtie-options-m"
2524   ><code
2525     >-m</code
2526     ></a
2527   >. If you would like to use Bowtie for larger values of <a href="#bowtie-options-k"
2528   ><code
2529     >-k</code
2530     ></a
2531   >, consider building an index with a denser suffix-array sample, i.e. specify a smaller <a href="#bowtie-build-options-o"
2532   ><code
2533     >-o</code
2534     >/<code
2535     >--offrate</code
2536     ></a
2537   > when invoking <code
2538   >bowtie-build</code
2539   > for the relevant index (see the <a href="#performance-tuning"
2540   >Performance tuning</a
2541   > section for details).</p
2542 ></td></tr><tr><td id="bowtie-options-M">
2543
2544
2545 <pre
2546 ><code
2547   >-M &lt;int&gt;
2548 </code
2549   ></pre
2550 ></td><td>
2551 <p
2552 >Behaves like <a href="#bowtie-options-m"
2553   ><code
2554     >-m</code
2555     ></a
2556   > except that if a read has more than <code
2557   >&lt;int&gt;</code
2558   > reportable alignments, one is reported at random. In <a href="#default-bowtie-output"
2559   >default output mode</a
2560   >, the selected alignment's 7th column is set to <code
2561   >&lt;int&gt;</code
2562   >+1 to indicate the read has at least <code
2563   >&lt;int&gt;</code
2564   >+1 valid alignments. In <a href="#bowtie-options-S"
2565   ><code
2566     >-S</code
2567     >/<code
2568     >--sam</code
2569     ></a
2570   > mode, the selected alignment is given a <code
2571   >MAPQ</code
2572   > (mapping quality) of 0 and the <code
2573   >XM:I</code
2574   > field is set to <code
2575   >&lt;int&gt;</code
2576   >+1. This option requires <a href="#bowtie-options-best"
2577   ><code
2578     >--best</code
2579     ></a
2580   >; if specified without <a href="#bowtie-options-best"
2581   ><code
2582     >--best</code
2583     ></a
2584   >, <a href="#bowtie-options-best"
2585   ><code
2586     >--best</code
2587     ></a
2588   > is enabled automatically.</p
2589 ></td></tr><tr><td id="bowtie-options-best">
2590
2591
2592 <pre
2593 ><code
2594   >--best
2595 </code
2596   ></pre
2597 ></td><td>
2598 <p
2599 >Make Bowtie guarantee that reported singleton alignments are &quot;best&quot; in terms of stratum (i.e. number of mismatches, or mismatches in the seed in the case of <a href="#bowtie-options-n"
2600   ><code
2601     >-n</code
2602     ></a
2603   > mode) and in terms of the quality values at the mismatched position(s). Stratum always trumps quality; e.g. a 1-mismatch alignment where the mismatched position has <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
2604   >Phred quality</a
2605   > 40 is preferred over a 2-mismatch alignment where the mismatched positions both have <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
2606   >Phred quality</a
2607   > 10. When <a href="#bowtie-options-best"
2608   ><code
2609     >--best</code
2610     ></a
2611   > is not specified, Bowtie may report alignments that are sub-optimal in terms of stratum and/or quality (though an effort is made to report the best alignment). <a href="#bowtie-options-best"
2612   ><code
2613     >--best</code
2614     ></a
2615   > mode also removes all strand bias. Note that <a href="#bowtie-options-best"
2616   ><code
2617     >--best</code
2618     ></a
2619   > does not affect which alignments are considered &quot;valid&quot; by <code
2620   >bowtie</code
2621   >, only which valid alignments are reported by <code
2622   >bowtie</code
2623   >. When <a href="#bowtie-options-best"
2624   ><code
2625     >--best</code
2626     ></a
2627   > is specified and multiple hits are allowed (via <a href="#bowtie-options-k"
2628   ><code
2629     >-k</code
2630     ></a
2631   > or <a href="#bowtie-options-a"
2632   ><code
2633     >-a</code
2634     ></a
2635   >), the alignments for a given read are guaranteed to appear in best-to-worst order in <code
2636   >bowtie</code
2637   >'s output. <code
2638   >bowtie</code
2639   > is somewhat slower when <a href="#bowtie-options-best"
2640   ><code
2641     >--best</code
2642     ></a
2643   > is specified.</p
2644 ></td></tr><tr><td id="bowtie-options-strata">
2645
2646
2647 <pre
2648 ><code
2649   >--strata
2650 </code
2651   ></pre
2652 ></td><td>
2653 <p
2654 >If many valid alignments exist and are reportable (e.g. are not disallowed via the <a href="#bowtie-options-k"
2655   ><code
2656     >-k</code
2657     ></a
2658   > option) and they fall into more than one alignment &quot;stratum&quot;, report only those alignments that fall into the best stratum. By default, Bowtie reports all reportable alignments regardless of whether they fall into multiple strata. When <a href="#bowtie-options-strata"
2659   ><code
2660     >--strata</code
2661     ></a
2662   > is specified, <a href="#bowtie-options-best"
2663   ><code
2664     >--best</code
2665     ></a
2666   > must also be specified.</p
2667 ></td></tr>
2668 </table>
2669 <h4 id="output"
2670 ><a href="#TOC"
2671   >Output</a
2672   ></h4
2673 ><table>
2674
2675 <tr><td id="bowtie-options-t">
2676
2677
2678
2679 <pre
2680 ><code
2681   >-t/--time
2682 </code
2683   ></pre
2684 ></td><td>
2685 <p
2686 >Print the amount of wall-clock time taken by each phase.</p
2687 ></td></tr><tr><td id="bowtie-options-B">
2688
2689
2690
2691 <pre
2692 ><code
2693   >-B/--offbase &lt;int&gt;
2694 </code
2695   ></pre
2696 ></td><td>
2697 <p
2698 >When outputting alignments, number the first base of a reference sequence as <code
2699   >&lt;int&gt;</code
2700   >. Default: 0.</p
2701 ></td></tr><tr><td id="bowtie-options-quiet">
2702
2703
2704 <pre
2705 ><code
2706   >--quiet
2707 </code
2708   ></pre
2709 ></td><td>
2710 <p
2711 >Print nothing besides alignments.</p
2712 ></td></tr><tr><td id="bowtie-options-refout">
2713
2714
2715 <pre
2716 ><code
2717   >--refout
2718 </code
2719   ></pre
2720 ></td><td>
2721 <p
2722 >Write alignments to a set of files named <code
2723   >refXXXXX.map</code
2724   >, where <code
2725   >XXXXX</code
2726   > is the 0-padded index of the reference sequence aligned to. This can be a useful way to break up work for downstream analyses when dealing with, for example, large numbers of reads aligned to the assembled human genome. If <code
2727   >&lt;hits&gt;</code
2728   > is also specified, it will be ignored.</p
2729 ></td></tr><tr><td id="bowtie-options-refidx">
2730
2731
2732 <pre
2733 ><code
2734   >--refidx
2735 </code
2736   ></pre
2737 ></td><td>
2738 <p
2739 >When a reference sequence is referred to in a reported alignment, refer to it by 0-based index (its offset into the list of references that were indexed) rather than by name.</p
2740 ></td></tr><tr><td id="bowtie-options-al">
2741
2742
2743 <pre
2744 ><code
2745   >--al &lt;filename&gt;
2746 </code
2747   ></pre
2748 ></td><td>
2749 <p
2750 >Write all reads for which at least one alignment was reported to a file with name <code
2751   >&lt;filename&gt;</code
2752   >. Written reads will appear as they did in the input, without any of the trimming or translation of quality values that may have taken place within <code
2753   >bowtie</code
2754   >. Paired-end reads will be written to two parallel files with <code
2755   >_1</code
2756   > and <code
2757   >_2</code
2758   > inserted in the filename, e.g., if <code
2759   >&lt;filename&gt;</code
2760   > is <code
2761   >aligned.fq</code
2762   >, the #1 and #2 mates that fail to align will be written to <code
2763   >aligned_1.fq</code
2764   > and <code
2765   >aligned_2.fq</code
2766   > respectively.</p
2767 ></td></tr><tr><td id="bowtie-options-un">
2768
2769
2770 <pre
2771 ><code
2772   >--un &lt;filename&gt;
2773 </code
2774   ></pre
2775 ></td><td>
2776 <p
2777 >Write all reads that could not be aligned to a file with name <code
2778   >&lt;filename&gt;</code
2779   >. Written reads will appear as they did in the input, without any of the trimming or translation of quality values that may have taken place within Bowtie. Paired-end reads will be written to two parallel files with <code
2780   >_1</code
2781   > and <code
2782   >_2</code
2783   > inserted in the filename, e.g., if <code
2784   >&lt;filename&gt;</code
2785   > is <code
2786   >unaligned.fq</code
2787   >, the #1 and #2 mates that fail to align will be written to <code
2788   >unaligned_1.fq</code
2789   > and <code
2790   >unaligned_2.fq</code
2791   > respectively. Unless <a href="#bowtie-options-max"
2792   ><code
2793     >--max</code
2794     ></a
2795   > is also specified, reads with a number of valid alignments exceeding the limit set with the <a href="#bowtie-options-m"
2796   ><code
2797     >-m</code
2798     ></a
2799   > option are also written to <code
2800   >&lt;filename&gt;</code
2801   >.</p
2802 ></td></tr><tr><td id="bowtie-options-max">
2803
2804
2805 <pre
2806 ><code
2807   >--max &lt;filename&gt;
2808 </code
2809   ></pre
2810 ></td><td>
2811 <p
2812 >Write all reads with a number of valid alignments exceeding the limit set with the <a href="#bowtie-options-m"
2813   ><code
2814     >-m</code
2815     ></a
2816   > option to a file with name <code
2817   >&lt;filename&gt;</code
2818   >. Written reads will appear as they did in the input, without any of the trimming or translation of quality values that may have taken place within <code
2819   >bowtie</code
2820   >. Paired-end reads will be written to two parallel files with <code
2821   >_1</code
2822   > and <code
2823   >_2</code
2824   > inserted in the filename, e.g., if <code
2825   >&lt;filename&gt;</code
2826   > is <code
2827   >max.fq</code
2828   >, the #1 and #2 mates that exceed the <a href="#bowtie-options-m"
2829   ><code
2830     >-m</code
2831     ></a
2832   > limit will be written to <code
2833   >max_1.fq</code
2834   > and <code
2835   >max_2.fq</code
2836   > respectively. These reads are not written to the file specified with <a href="#bowtie-options-un"
2837   ><code
2838     >--un</code
2839     ></a
2840   >.</p
2841 ></td></tr><tr><td id="bowtie-options-suppress">
2842
2843
2844 <pre
2845 ><code
2846   >--suppress &lt;cols&gt;
2847 </code
2848   ></pre
2849 ></td><td>
2850 <p
2851 >Suppress columns of output in the <a href="#default-bowtie-output"
2852   >default output mode</a
2853   >. E.g. if <code
2854   >--suppress 1,5,6</code
2855   > is specified, the read name, read sequence, and read quality fields will be omitted. See <a href="#default-bowtie-output"
2856   >Default Bowtie output</a
2857   > for field descriptions. This option is ignored if the output mode is <a href="#bowtie-options-S"
2858   ><code
2859     >-S</code
2860     >/<code
2861     >--sam</code
2862     ></a
2863   >.</p
2864 ></td></tr>
2865 <tr><td id="bowtie-options-fullref">
2866
2867
2868 <pre
2869 ><code
2870   >--fullref
2871 </code
2872   ></pre
2873 ></td><td>
2874 <p
2875 >Print the full refernce sequence name, including whitespace, in alignment output. By default <code
2876   >bowtie</code
2877   > prints everything up to but not including the first whitespace.</p
2878 ></td></tr></table>
2879 <h4 id="colorspace"
2880 ><a href="#TOC"
2881   >Colorspace</a
2882   ></h4
2883 ><table>
2884 <tr><td id="bowtie-options-snpphred">
2885
2886
2887 <pre
2888 ><code
2889   >--snpphred &lt;int&gt;
2890 </code
2891   ></pre
2892 ></td><td>
2893 <p
2894 >When decoding colorspace alignments, use <code
2895   >&lt;int&gt;</code
2896   > as the SNP penalty. This should be set to the user's best guess of the true ratio of SNPs per base in the subject genome, converted to the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
2897   >Phred quality</a
2898   > scale. E.g., if the user expects about 1 SNP every 1,000 positions, <code
2899   >--snpphred</code
2900   > should be set to 30 (which is also the default). To specify the fraction directly, use <a href="#bowtie-options-snpfrac"
2901   ><code
2902     >--snpfrac</code
2903     ></a
2904   >.</p
2905 ></td></tr>
2906 <tr><td id="bowtie-options-snpfrac">
2907
2908
2909 <pre
2910 ><code
2911   >--snpfrac &lt;dec&gt;
2912 </code
2913   ></pre
2914 ></td><td>
2915 <p
2916 >When decoding colorspace alignments, use <code
2917   >&lt;dec&gt;</code
2918   > as the estimated ratio of SNPs per base. For best decoding results, this should be set to the user's best guess of the true ratio. <code
2919   >bowtie</code
2920   > internally converts the ratio to a <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
2921   >Phred quality</a
2922   >, and behaves as if that quality had been set via the <a href="#bowtie-options-snpphred"
2923   ><code
2924     >--snpphred</code
2925     ></a
2926   > option. Default: 0.001.</p
2927 ></td></tr>
2928 <tr><td id="bowtie-options-col-cseq">
2929
2930
2931 <pre
2932 ><code
2933   >--col-cseq
2934 </code
2935   ></pre
2936 ></td><td>
2937 <p
2938 >If reads are in colorspace and the <a href="#default-bowtie-output"
2939   >default output mode</a
2940   > is active, <code
2941   >--col-cseq</code
2942   > causes the reads' color sequence to appear in the read-sequence column (column 5) instead of the decoded nucleotide sequence. See the <a href="#decoding-colorspace-alignments"
2943   >Decoding colorspace alignments</a
2944   > section for details about decoding. This option is ignored in <a href="#bowtie-options-S"
2945   ><code
2946     >-S</code
2947     >/<code
2948     >--sam</code
2949     ></a
2950   > mode.</p
2951 ></td></tr>
2952 <tr><td id="bowtie-options-col-cqual">
2953
2954
2955 <pre
2956 ><code
2957   >--col-cqual
2958 </code
2959   ></pre
2960 ></td><td>
2961 <p
2962 >If reads are in colorspace and the <a href="#default-bowtie-output"
2963   >default output mode</a
2964   > is active, <code
2965   >--col-cqual</code
2966   > causes the reads' original (color) quality sequence to appear in the quality column (column 6) instead of the decoded qualities. See the <a href="#colorspace-alignment"
2967   >Colorspace alignment</a
2968   > section for details about decoding. This option is ignored in <a href="#bowtie-options-S"
2969   ><code
2970     >-S</code
2971     >/<code
2972     >--sam</code
2973     ></a
2974   > mode.</p
2975 ></td></tr>
2976 <tr><td id="bowtie-options-col-keepends">
2977
2978
2979 <pre
2980 ><code
2981   >--col-keepends
2982 </code
2983   ></pre
2984 ></td><td>
2985 <p
2986 >When decoding colorpsace alignments, <code
2987   >bowtie</code
2988   > trims off a nucleotide and quality from the left and right edges of the alignment. This is because those nucleotides are supported by only one color, in contrast to the middle nucleotides which are supported by two. Specify <code
2989   >--col-keepends</code
2990   > to keep the extreme-end nucleotides and qualities.</p
2991 ></td></tr>
2992 </table>
2993 <h4 id="sam"
2994 ><a href="#TOC"
2995   >SAM</a
2996   ></h4
2997 ><table>
2998
2999 <tr><td id="bowtie-options-S">
3000
3001
3002
3003 <pre
3004 ><code
3005   >-S/--sam
3006 </code
3007   ></pre
3008 ></td><td>
3009 <p
3010 >Print alignments in <a href="http://samtools.sourceforge.net/SAM1.pdf"
3011   >SAM</a
3012   > format. See the <a href="#sam-bowtie-output"
3013   >SAM output</a
3014   > section of the manual for details. To suppress all SAM headers, use <a href="#bowtie-options-sam-nohead"
3015   ><code
3016     >--sam-nohead</code
3017     ></a
3018   > in addition to <code
3019   >-S/--sam</code
3020   >. To suppress just the <code
3021   >@SQ</code
3022   > headers (e.g. if the alignment is against a very large number of reference sequences), use <a href="#bowtie-options-sam-nosq"
3023   ><code
3024     >--sam-nosq</code
3025     ></a
3026   > in addition to <code
3027   >-S/--sam</code
3028   >. <code
3029   >bowtie</code
3030   > does not write BAM files directly, but SAM output can be converted to BAM on the fly by piping <code
3031   >bowtie</code
3032   >'s output to <code
3033   >samtools view</code
3034   >. <a href="#bowtie-options-S"
3035   ><code
3036     >-S</code
3037     >/<code
3038     >--sam</code
3039     ></a
3040   > is not compatible with <a href="#bowtie-options-refout"
3041   ><code
3042     >--refout</code
3043     ></a
3044   >.</p
3045 ></td></tr><tr><td id="bowtie-options-mapq">
3046
3047
3048 <pre
3049 ><code
3050   >--mapq &lt;int&gt;
3051 </code
3052   ></pre
3053 ></td><td>
3054 <p
3055 >If an alignment is non-repetitive (according to <a href="#bowtie-options-m"
3056   ><code
3057     >-m</code
3058     ></a
3059   >, <a href="#bowtie-options-strata"
3060   ><code
3061     >--strata</code
3062     ></a
3063   > and other options) set the <code
3064   >MAPQ</code
3065   > (mapping quality) field to this value. See the <a href="http://samtools.sourceforge.net/SAM1.pdf"
3066   >SAM Spec</a
3067   > for details about the <code
3068   >MAPQ</code
3069   > field Default: 255.</p
3070 ></td></tr><tr><td id="bowtie-options-sam-nohead">
3071
3072
3073 <pre
3074 ><code
3075   >--sam-nohead
3076 </code
3077   ></pre
3078 ></td><td>
3079 <p
3080 >Suppress header lines (starting with <code
3081   >@</code
3082   >) when output is <a href="#bowtie-options-S"
3083   ><code
3084     >-S</code
3085     >/<code
3086     >--sam</code
3087     ></a
3088   >. This must be specified <em
3089   >in addition to</em
3090   > <a href="#bowtie-options-S"
3091   ><code
3092     >-S</code
3093     >/<code
3094     >--sam</code
3095     ></a
3096   >. <code
3097   >--sam-nohead</code
3098   > is ignored unless <a href="#bowtie-options-S"
3099   ><code
3100     >-S</code
3101     >/<code
3102     >--sam</code
3103     ></a
3104   > is also specified.</p
3105 ></td></tr><tr><td id="bowtie-options-sam-nosq">
3106
3107
3108 <pre
3109 ><code
3110   >--sam-nosq
3111 </code
3112   ></pre
3113 ></td><td>
3114 <p
3115 >Suppress <code
3116   >@SQ</code
3117   > header lines when output is <a href="#bowtie-options-S"
3118   ><code
3119     >-S</code
3120     >/<code
3121     >--sam</code
3122     ></a
3123   >. This must be specified <em
3124   >in addition to</em
3125   > <a href="#bowtie-options-S"
3126   ><code
3127     >-S</code
3128     >/<code
3129     >--sam</code
3130     ></a
3131   >. <code
3132   >--sam-nosq</code
3133   > is ignored unless <a href="#bowtie-options-S"
3134   ><code
3135     >-S</code
3136     >/<code
3137     >--sam</code
3138     ></a
3139   > is also specified.</p
3140 ></td></tr><tr><td id="bowtie-options-sam-RG">
3141
3142
3143 <pre
3144 ><code
3145   >--sam-RG &lt;text&gt;
3146 </code
3147   ></pre
3148 ></td><td>
3149 <p
3150 >Add <code
3151   >&lt;text&gt;</code
3152   > (usually of the form <code
3153   >TAG:VAL</code
3154   >, e.g. <code
3155   >ID:IL7LANE2</code
3156   >) as a field on the <code
3157   >@RG</code
3158   > header line. Specify <code
3159   >--sam-RG</code
3160   > multiple times to set multiple fields. See the <a href="http://samtools.sourceforge.net/SAM1.pdf"
3161   >SAM Spec</a
3162   > for details about what fields are legal. Note that, if any <code
3163   >@RG</code
3164   > fields are set using this option, the <code
3165   >ID</code
3166   > and <code
3167   >SM</code
3168   > fields must both be among them to make the <code
3169   >@RG</code
3170   > line legal according to the <a href="http://samtools.sourceforge.net/SAM1.pdf"
3171   >SAM Spec</a
3172   >. <code
3173   >--sam-RG</code
3174   > is ignored unless <a href="#bowtie-options-S"
3175   ><code
3176     >-S</code
3177     >/<code
3178     >--sam</code
3179     ></a
3180   > is also specified.</p
3181 ></td></tr></table>
3182 <h4 id="performance"
3183 ><a href="#TOC"
3184   >Performance</a
3185   ></h4
3186 ><table><tr>
3187
3188 <td id="bowtie-options-o">
3189
3190
3191
3192
3193 <pre
3194 ><code
3195   >-o/--offrate &lt;int&gt;
3196 </code
3197   ></pre
3198 ></td><td>
3199 <p
3200 >Override the offrate of the index with <code
3201   >&lt;int&gt;</code
3202   >. If <code
3203   >&lt;int&gt;</code
3204   > is greater than the offrate used to build the index, then some row markings are discarded when the index is read into memory. This reduces the memory footprint of the aligner but requires more time to calculate text offsets. <code
3205   >&lt;int&gt;</code
3206   > must be greater than the value used to build the index.</p
3207 ></td></tr><tr><td id="bowtie-options-p">
3208
3209
3210
3211 <pre
3212 ><code
3213   >-p/--threads &lt;int&gt;
3214 </code
3215   ></pre
3216 ></td><td>
3217 <p
3218 >Launch <code
3219   >&lt;int&gt;</code
3220   > parallel search threads (default: 1). Threads will run on separate processors/cores and synchronize when parsing reads and outputting alignments. Searching for alignments is highly parallel, and speedup is fairly close to linear. This option is only available if <code
3221   >bowtie</code
3222   > is linked with the <code
3223   >pthreads</code
3224   > library (i.e. if <code
3225   >BOWTIE_PTHREADS=0</code
3226   > is not specified at build time).</p
3227 ></td></tr><tr><td id="bowtie-options-mm">
3228
3229
3230 <pre
3231 ><code
3232   >--mm
3233 </code
3234   ></pre
3235 ></td><td>
3236 <p
3237 >Use memory-mapped I/O to load the index, rather than normal C file I/O. Memory-mapping the index allows many concurrent <code
3238   >bowtie</code
3239   > processes on the same computer to share the same memory image of the index (i.e. you pay the memory overhead just once). This facilitates memory-efficient parallelization of <code
3240   >bowtie</code
3241   > in situations where using <a href="#bowtie-options-p"
3242   ><code
3243     >-p</code
3244     ></a
3245   > is not possible.</p
3246 ></td></tr><tr><td id="bowtie-options-shmem">
3247
3248
3249 <pre
3250 ><code
3251   >--shmem
3252 </code
3253   ></pre
3254 ></td><td>
3255 <p
3256 >Use shared memory to load the index, rather than normal C file I/O. Using shared memory allows many concurrent bowtie processes on the same computer to share the same memory image of the index (i.e. you pay the memory overhead just once). This facilitates memory-efficient parallelization of <code
3257   >bowtie</code
3258   > in situations where using <a href="#bowtie-options-p"
3259   ><code
3260     >-p</code
3261     ></a
3262   > is not desirable. Unlike <a href="#bowtie-options-mm"
3263   ><code
3264     >--mm</code
3265     ></a
3266   >, <code
3267   >--shmem</code
3268   > installs the index into shared memory permanently, or until the user deletes the shared memory chunks manually. See your operating system documentation for details on how to manually list and remove shared memory chunks (on Linux and Mac OS X, these commands are <code
3269   >ipcs</code
3270   > and <code
3271   >ipcrm</code
3272   >). You may also need to increase your OS's maximum shared-memory chunk size to accomodate larger indexes; see your OS documentation.</p
3273 ></td></tr></table>
3274 <h4 id="other"
3275 ><a href="#TOC"
3276   >Other</a
3277   ></h4
3278 ><table><tr><td id="bowtie-options-seed">
3279
3280
3281 <pre
3282 ><code
3283   >--seed &lt;int&gt;
3284 </code
3285   ></pre
3286 ></td><td>
3287 <p
3288 >Use <code
3289   >&lt;int&gt;</code
3290   > as the seed for pseudo-random number generator.</p
3291 ></td></tr><tr><td id="bowtie-options-verbose">
3292
3293
3294 <pre
3295 ><code
3296   >--verbose
3297 </code
3298   ></pre
3299 ></td><td>
3300 <p
3301 >Print verbose output (for debugging).</p
3302 ></td></tr><tr><td id="bowtie-options-version">
3303
3304
3305 <pre
3306 ><code
3307   >--version
3308 </code
3309   ></pre
3310 ></td><td>
3311 <p
3312 >Print version information and quit.</p
3313 ></td></tr><tr><td id="bowtie-options-h">
3314 <pre
3315 ><code
3316   >-h/--help
3317 </code
3318   ></pre
3319 ></td><td>
3320 <p
3321 >Print usage information and quit.</p
3322 ></td></tr></table>
3323 <h2 id="default-bowtie-output"
3324 ><a href="#TOC"
3325   >Default <code
3326     >bowtie</code
3327     > output</a
3328   ></h2
3329 ><p
3330 ><code
3331   >bowtie</code
3332   > outputs one alignment per line. Each line is a collection of 8 fields separated by tabs; from left to right, the fields are:</p
3333 ><ol style="list-style-type: decimal;"
3334 ><li
3335   ><p
3336     >Name of read that aligned</p
3337     ></li
3338   ><li
3339   ><p
3340     >Reference strand aligned to, <code
3341       >+</code
3342       > for forward strand, <code
3343       >-</code
3344       > for reverse</p
3345     ></li
3346   ><li
3347   ><p
3348     >Name of reference sequence where alignment occurs, or numeric ID if no name was provided</p
3349     ></li
3350   ><li
3351   ><p
3352     >0-based offset into the forward reference strand where leftmost character of the alignment occurs</p
3353     ></li
3354   ><li
3355   ><p
3356     >Read sequence (reverse-complemented if orientation is <code
3357       >-</code
3358       >).</p
3359     ><p
3360     >If the read was in colorspace, then the sequence shown in this column is the sequence of <em
3361       >decoded nucleotides</em
3362       >, not the original colors. See the <a href="#colorspace-alignment"
3363       >Colorspace alignment</a
3364       > section for details about decoding. To display colors instead, use the <a href="#bowtie-options-col-cseq"
3365       ><code
3366         >--col-cseq</code
3367         ></a
3368       > option.</p
3369     ></li
3370   ><li
3371   ><p
3372     >ASCII-encoded read qualities (reversed if orientation is <code
3373       >-</code
3374       >). The encoded quality values are on the Phred scale and the encoding is ASCII-offset by 33 (ASCII char <code
3375       >!</code
3376       >).</p
3377     ><p
3378     >If the read was in colorspace, then the qualities shown in this column are the <em
3379       >decoded qualities</em
3380       >, not the original qualities. See the <a href="#colorspace-alignment"
3381       >Colorspace alignment</a
3382       > section for details about decoding. To display colors instead, use the <a href="#bowtie-options-col-cqual"
3383       ><code
3384         >--col-cqual</code
3385         ></a
3386       > option.</p
3387     ></li
3388   ><li
3389   ><p
3390     >If <a href="#bowtie-options-M"
3391       ><code
3392         >-M</code
3393         ></a
3394       > was specified and the prescribed ceiling was exceeded for this read, this column contains the value of the ceiling, indicating that at least that many valid alignments were found in addition to the one reported.</p
3395     ><p
3396     >Otherwise, this column contains the number of other instances where the same sequence aligned against the same reference characters as were aligned against in the reported alignment. This is <em
3397       >not</em
3398       > the number of other places the read aligns with the same number of mismatches. The number in this column is generally not a good proxy for that number (e.g., the number in this column may be '0' while the number of other alignments with the same number of mismatches might be large).</p
3399     ></li
3400   ><li
3401   ><p
3402     >Comma-separated list of mismatch descriptors. If there are no mismatches in the alignment, this field is empty. A single descriptor has the format offset:reference-base&gt;read-base. The offset is expressed as a 0-based offset from the high-quality (5') end of the read.</p
3403     ></li
3404   ></ol
3405 ><h2 id="sam-bowtie-output"
3406 ><a href="#TOC"
3407   >SAM <code
3408     >bowtie</code
3409     > output</a
3410   ></h2
3411 ><p
3412 >Following is a brief description of the <a href="http://samtools.sourceforge.net/SAM1.pdf"
3413   >SAM</a
3414   > format as output by <code
3415   >bowtie</code
3416   > when the <a href="#bowtie-options-S"
3417   ><code
3418     >-S</code
3419     >/<code
3420     >--sam</code
3421     ></a
3422   > option is specified. For more details, see the <a href="http://samtools.sourceforge.net/SAM1.pdf"
3423   >SAM format specification</a
3424   >.</p
3425 ><p
3426 >When <a href="#bowtie-options-S"
3427   ><code
3428     >-S</code
3429     >/<code
3430     >--sam</code
3431     ></a
3432   > is specified, <code
3433   >bowtie</code
3434   > prints a SAM header with <code
3435   >@HD</code
3436   >, <code
3437   >@SQ</code
3438   > and <code
3439   >@PG</code
3440   > lines. When one or more <a href="#bowtie-options-sam-RG"
3441   ><code
3442     >--sam-RG</code
3443     ></a
3444   > arguments are specified, <code
3445   >bowtie</code
3446   > will also print an <code
3447   >@RG</code
3448   > line that includes all user-specified <a href="#bowtie-options-sam-RG"
3449   ><code
3450     >--sam-RG</code
3451     ></a
3452   > tokens separated by tabs.</p
3453 ><p
3454 >Each subsequnt line corresponds to a read or an alignment. Each line is a collection of at least 12 fields separated by tabs; from left to right, the fields are:</p
3455 ><ol style="list-style-type: decimal;"
3456 ><li
3457   ><p
3458     >Name of read that aligned</p
3459     ></li
3460   ><li
3461   ><p
3462     >Sum of all applicable flags. Flags relevant to Bowtie are:</p
3463     ><table><tr><td>
3464 <pre
3465     ><code
3466       >1
3467 </code
3468       ></pre
3469     ></td><td>
3470 <p
3471     >The read is one of a pair</p
3472     ></td></tr><tr><td>
3473 <pre
3474     ><code
3475       >2
3476 </code
3477       ></pre
3478     ></td><td>
3479 <p
3480     >The alignment is one end of a proper paired-end alignment</p
3481     ></td></tr><tr><td>
3482 <pre
3483     ><code
3484       >4
3485 </code
3486       ></pre
3487     ></td><td>
3488 <p
3489     >The read has no reported alignments</p
3490     ></td></tr><tr><td>
3491 <pre
3492     ><code
3493       >8
3494 </code
3495       ></pre
3496     ></td><td>
3497 <p
3498     >The read is one of a pair and has no reported alignments</p
3499     ></td></tr><tr><td>
3500 <pre
3501     ><code
3502       >16
3503 </code
3504       ></pre
3505     ></td><td>
3506 <p
3507     >The alignment is to the reverse reference strand</p
3508     ></td></tr><tr><td>
3509 <pre
3510     ><code
3511       >32
3512 </code
3513       ></pre
3514     ></td><td>
3515 <p
3516     >The other mate in the paired-end alignment is aligned to the reverse reference strand</p
3517     ></td></tr><tr><td>
3518 <pre
3519     ><code
3520       >64
3521 </code
3522       ></pre
3523     ></td><td>
3524 <p
3525     >The read is the first (#1) mate in a pair</p
3526     ></td></tr><tr><td>
3527 <pre
3528     ><code
3529       >128
3530 </code
3531       ></pre
3532     ></td><td>
3533 <p
3534     >The read is the second (#2) mate in a pair</p
3535     ></td></tr></table>
3536 <p
3537     >Thus, an unpaired read that aligns to the reverse reference strand will have flag 16. A paired-end read that aligns and is the first mate in the pair will have flag 83 (= 64 + 16 + 2 + 1).</p
3538     ></li
3539   ><li
3540   ><p
3541     >Name of reference sequence where alignment occurs, or ordinal ID if no name was provided</p
3542     ></li
3543   ><li
3544   ><p
3545     >1-based offset into the forward reference strand where leftmost character of the alignment occurs</p
3546     ></li
3547   ><li
3548   ><p
3549     >Mapping quality</p
3550     ></li
3551   ><li
3552   ><p
3553     >CIGAR string representation of alignment</p
3554     ></li
3555   ><li
3556   ><p
3557     >Name of reference sequence where mate's alignment occurs. Set to <code
3558       >=</code
3559       > if the mate's reference sequence is the same as this alignment's, or <code
3560       >*</code
3561       > if there is no mate.</p
3562     ></li
3563   ><li
3564   ><p
3565     >1-based offset into the forward reference strand where leftmost character of the mate's alignment occurs. Offset is 0 if there is no mate.</p
3566     ></li
3567   ><li
3568   ><p
3569     >Inferred insert size. Size is negative if the mate's alignment occurs upstream of this alignment. Size is 0 if there is no mate.</p
3570     ></li
3571   ><li
3572   ><p
3573     >Read sequence (reverse-complemented if aligned to the reverse strand)</p
3574     ></li
3575   ><li
3576   ><p
3577     >ASCII-encoded read qualities (reverse-complemented if the read aligned to the reverse strand). The encoded quality values are on the <a href="http://en.wikipedia.org/wiki/FASTQ_format#Variations"
3578       >Phred quality</a
3579       > scale and the encoding is ASCII-offset by 33 (ASCII char <code
3580       >!</code
3581       >), similarly to a <a href="http://en.wikipedia.org/wiki/FASTQ_format"
3582       >FASTQ</a
3583       > file.</p
3584     ></li
3585   ><li
3586   ><p
3587     >Optional fields. Fields are tab-separated. For descriptions of all possible optional fields, see the SAM format specification. <code
3588       >bowtie</code
3589       > outputs some of these optional fields for each alignment, depending on the type of the alignment:</p
3590     ><table><tr><td>
3591 <pre
3592     ><code
3593       >NM:i:&lt;N&gt;
3594 </code
3595       ></pre
3596     ></td><td>
3597 <p
3598     >Aligned read has an edit distance of <code
3599       >&lt;N&gt;</code
3600       >.</p
3601     ></td></tr><tr><td>
3602 <pre
3603     ><code
3604       >CM:i:&lt;N&gt;
3605 </code
3606       ></pre
3607     ></td><td>
3608 <p
3609     >Aligned read has an edit distance of <code
3610       >&lt;N&gt;</code
3611       > in colorspace. This field is present in addition to the <code
3612       >NM</code
3613       > field in <a href="#bowtie-options-C"
3614       ><code
3615         >-C</code
3616         >/<code
3617         >--color</code
3618         ></a
3619       > mode, but is omitted otherwise.</p
3620     ></td></tr><tr><td>
3621 <pre
3622     ><code
3623       >MD:Z:&lt;S&gt;
3624 </code
3625       ></pre
3626     ></td><td>
3627 <p
3628     >For aligned reads, <code
3629       >&lt;S&gt;</code
3630       > is a string representation of the mismatched reference bases in the alignment. See <a href="http://samtools.sourceforge.net/SAM1.pdf"
3631       >SAM</a
3632       > format specification for details. For colorspace alignments, <code
3633       >&lt;S&gt;</code
3634       > describes the decoded <em
3635       >nucleotide</em
3636       > alignment, not the colorspace alignment.</p
3637     ></td></tr><tr><td>
3638 <pre
3639     ><code
3640       >XA:i:&lt;N&gt;
3641 </code
3642       ></pre
3643     ></td><td>
3644 <p
3645     >Aligned read belongs to stratum <code
3646       >&lt;N&gt;</code
3647       >. See <a href="#strata"
3648       >Strata</a
3649       > for definition.</p
3650     ></td></tr><tr><td>
3651 <pre
3652     ><code
3653       >XM:i:&lt;N&gt;
3654 </code
3655       ></pre
3656     ></td><td>
3657 <p
3658     >For a read with no reported alignments, <code
3659       >&lt;N&gt;</code
3660       > is 0 if the read had no alignments. If <a href="#bowtie-options-m"
3661       ><code
3662         >-m</code
3663         ></a
3664       > was specified and the read's alignments were supressed because the <a href="#bowtie-options-m"
3665       ><code
3666         >-m</code
3667         ></a
3668       > ceiling was exceeded, <code
3669       >&lt;N&gt;</code
3670       > equals the <a href="#bowtie-options-m"
3671       ><code
3672         >-m</code
3673         ></a
3674       > ceiling + 1, to indicate that there were at least that many valid alignments (but all were suppressed). In <a href="#bowtie-options-M"
3675       ><code
3676         >-M</code
3677         ></a
3678       > mode, if the alignment was randomly selected because the <a href="#bowtie-options-M"
3679       ><code
3680         >-M</code
3681         ></a
3682       > ceiling was exceeded, <code
3683       >&lt;N&gt;</code
3684       > equals the <a href="#bowtie-options-M"
3685       ><code
3686         >-M</code
3687         ></a
3688       > ceiling + 1, to indicate that there were at least that many valid alignments (of which one was reported at random).</p
3689     ></td></tr></table>
3690
3691
3692
3693
3694
3695 </li
3696   ></ol
3697 ><h1 id="the-bowtie-build-indexer"
3698 ><a href="#TOC"
3699   >The <code
3700     >bowtie-build</code
3701     > indexer</a
3702   ></h1
3703 ><p
3704 ><code
3705   >bowtie-build</code
3706   > builds a Bowtie index from a set of DNA sequences. <code
3707   >bowtie-build</code
3708   > outputs a set of 6 files with suffixes <code
3709   >.1.ebwt</code
3710   >, <code
3711   >.2.ebwt</code
3712   >, <code
3713   >.3.ebwt</code
3714   >, <code
3715   >.4.ebwt</code
3716   >, <code
3717   >.rev.1.ebwt</code
3718   >, and <code
3719   >.rev.2.ebwt</code
3720   >. These files together constitute the index: they are all that is needed to align reads to that reference. The original sequence files are no longer used by Bowtie once the index is built.</p
3721 ><p
3722 >Use of Karkkainen's [blockwise algorithm] allows <code
3723   >bowtie-build</code
3724   > to trade off between running time and memory usage. <code
3725   >bowtie-build</code
3726   > has three options governing how it makes this trade: <a href="#bowtie-build-options-p"
3727   ><code
3728     >-p</code
3729     >/<code
3730     >--packed</code
3731     ></a
3732   >, <a href="#bowtie-build-options-bmax"
3733   ><code
3734     >--bmax</code
3735     ></a
3736   >/<a href="#bowtie-build-options-bmaxdivn"
3737   ><code
3738     >--bmaxdivn</code
3739     ></a
3740   >, and <a href="#bowtie-build-options-dcv"
3741   ><code
3742     >--dcv</code
3743     ></a
3744   >. By default, <code
3745   >bowtie-build</code
3746   > will automatically search for the settings that yield the best running time without exhausting memory. This behavior can be disabled using the <a href="#bowtie-build-options-a"
3747   ><code
3748     >-a</code
3749     >/<code
3750     >--noauto</code
3751     ></a
3752   > option.</p
3753 ><p
3754 >The indexer provides options pertaining to the &quot;shape&quot; of the index, e.g. <a href="#bowtie-build-options-o"
3755   ><code
3756     >--offrate</code
3757     ></a
3758   > governs the fraction of <a href="http://en.wikipedia.org/wiki/Burrows-Wheeler_transform"
3759   >Burrows-Wheeler</a
3760   > rows that are &quot;marked&quot; (i.e., the density of the suffix-array sample; see the original <a href="http://portal.acm.org/citation.cfm?id=796543"
3761   >FM Index</a
3762   > paper for details). All of these options are potentially profitable trade-offs depending on the application. They have been set to defaults that are reasonable for most cases according to our experiments. See [Performance Tuning] for details.</p
3763 ><p
3764 >Because <code
3765   >bowtie-build</code
3766   > uses 32-bit pointers internally, it can handle up to a theoretical maximum of 2^32-1 (somewhat more than 4 billion) characters in an index, though, with other constraints, the actual ceiling is somewhat less than that. If your reference exceeds 2^32-1 characters, <code
3767   >bowtie-build</code
3768   > will print an error message and abort. To resolve this, divide your reference sequences into smaller batches and/or chunks and build a separate index for each.</p
3769 ><p
3770 >If your computer has more than 3-4 GB of memory and you would like to exploit that fact to make index building faster, use a 64-bit version of the <code
3771   >bowtie-build</code
3772   > binary. The 32-bit version of the binary is restricted to using less than 4 GB of memory. If a 64-bit pre-built binary does not yet exist for your platform on the sourceforge download site, you will need to build one from source.</p
3773 ><p
3774 >The Bowtie index is based on the <a href="http://portal.acm.org/citation.cfm?id=796543"
3775   >FM Index</a
3776   > of Ferragina and Manzini, which in turn is based on the <a href="http://en.wikipedia.org/wiki/Burrows-Wheeler_transform"
3777   >Burrows-Wheeler</a
3778   > transform. The algorithm used to build the index is based on the [blockwise algorithm] of Karkkainen.</p
3779 ><h2 id="command-line-1"
3780 ><a href="#TOC"
3781   >Command Line</a
3782   ></h2
3783 ><p
3784 >Usage:</p
3785 ><pre
3786 ><code
3787   >bowtie-build [options]* &lt;reference_in&gt; &lt;ebwt_base&gt;
3788 </code
3789   ></pre
3790 ><h3 id="main-arguments-1"
3791 ><a href="#TOC"
3792   >Main arguments</a
3793   ></h3
3794 ><table><tr><td>
3795 <pre
3796 ><code
3797   >&lt;reference_in&gt;
3798 </code
3799   ></pre
3800 ></td><td>
3801 <p
3802 >A comma-separated list of FASTA files containing the reference sequences to be aligned to, or, if <a href="#bowtie-build-options-c"
3803   ><code
3804     >-c</code
3805     ></a
3806   > is specified, the sequences themselves. E.g., <code
3807   >&lt;reference_in&gt;</code
3808   > might be <code
3809   >chr1.fa,chr2.fa,chrX.fa,chrY.fa</code
3810   >, or, if <a href="#bowtie-build-options-c"
3811   ><code
3812     >-c</code
3813     ></a
3814   > is specified, this might be <code
3815   >GGTCATCCT,ACGGGTCGT,CCGTTCTATGCGGCTTA</code
3816   >.</p
3817 ></td></tr><tr><td>
3818 <pre
3819 ><code
3820   >&lt;ebwt_base&gt;
3821 </code
3822   ></pre
3823 ></td><td>
3824 <p
3825 >The basename of the index files to write. By default, <code
3826   >bowtie-build</code
3827   > writes files named <code
3828   >NAME.1.ebwt</code
3829   >, <code
3830   >NAME.2.ebwt</code
3831   >, <code
3832   >NAME.3.ebwt</code
3833   >, <code
3834   >NAME.4.ebwt</code
3835   >, <code
3836   >NAME.rev.1.ebwt</code
3837   >, and <code
3838   >NAME.rev.2.ebwt</code
3839   >, where <code
3840   >NAME</code
3841   > is <code
3842   >&lt;ebwt_base&gt;</code
3843   >.</p
3844 ></td></tr></table>
3845 <h3 id="options-1"
3846 ><a href="#TOC"
3847   >Options</a
3848   ></h3
3849 ><table><tr><td>
3850 <pre
3851 ><code
3852   >-f
3853 </code
3854   ></pre
3855 ></td><td>
3856 <p
3857 >The reference input files (specified as <code
3858   >&lt;reference_in&gt;</code
3859   >) are FASTA files (usually having extension <code
3860   >.fa</code
3861   >, <code
3862   >.mfa</code
3863   >, <code
3864   >.fna</code
3865   > or similar).</p
3866 ></td></tr><tr><td id="bowtie-build-options-c">
3867 <pre
3868 ><code
3869   >-c
3870 </code
3871   ></pre
3872 ></td><td>
3873 <p
3874 >The reference sequences are given on the command line. I.e. <code
3875   >&lt;reference_in&gt;</code
3876   > is a comma-separated list of sequences rather than a list of FASTA files.</p
3877 ></td></tr><tr><td id="bowtie-build-options-C">
3878 <pre
3879 ><code
3880   >-C/--color
3881 </code
3882   ></pre
3883 ></td><td>
3884 <p
3885 >Build a colorspace index, to be queried using <code
3886   >bowtie</code
3887   > <a href="#bowtie-options-C"
3888   ><code
3889     >-C</code
3890     ></a
3891   >.</p
3892 ></td></tr><tr><td id="bowtie-build-options-a">
3893
3894
3895 <pre
3896 ><code
3897   >-a/--noauto
3898 </code
3899   ></pre
3900 ></td><td>
3901 <p
3902 >Disable the default behavior whereby <code
3903   >bowtie-build</code
3904   > automatically selects values for the <a href="#bowtie-build-options-bmax"
3905   ><code
3906     >--bmax</code
3907     ></a
3908   >, <a href="#bowtie-build-options-dcv"
3909   ><code
3910     >--dcv</code
3911     ></a
3912   > and <a href="#bowtie-build-options-p"
3913   ><code
3914     >--packed</code
3915     ></a
3916   > parameters according to available memory. Instead, user may specify values for those parameters. If memory is exhausted during indexing, an error message will be printed; it is up to the user to try new parameters.</p
3917 ></td></tr><tr><td id="bowtie-build-options-p">
3918
3919
3920
3921 <pre
3922 ><code
3923   >-p/--packed
3924 </code
3925   ></pre
3926 ></td><td>
3927 <p
3928 >Use a packed (2-bits-per-nucleotide) representation for DNA strings. This saves memory but makes indexing 2-3 times slower. Default: off. This is configured automatically by default; use <a href="#bowtie-build-options-a"
3929   ><code
3930     >-a</code
3931     >/<code
3932     >--noauto</code
3933     ></a
3934   > to configure manually.</p
3935 ></td></tr><tr><td id="bowtie-build-options-bmax">
3936
3937
3938 <pre
3939 ><code
3940   >--bmax &lt;int&gt;
3941 </code
3942   ></pre
3943 ></td><td>
3944 <p
3945 >The maximum number of suffixes allowed in a block. Allowing more suffixes per block makes indexing faster, but increases peak memory usage. Setting this option overrides any previous setting for <a href="#bowtie-build-options-bmax"
3946   ><code
3947     >--bmax</code
3948     ></a
3949   >, or <a href="#bowtie-build-options-bmaxdivn"
3950   ><code
3951     >--bmaxdivn</code
3952     ></a
3953   >. Default (in terms of the <a href="#bowtie-build-options-bmaxdivn"
3954   ><code
3955     >--bmaxdivn</code
3956     ></a
3957   > parameter) is <a href="#bowtie-build-options-bmaxdivn"
3958   ><code
3959     >--bmaxdivn</code
3960     ></a
3961   > 4. This is configured automatically by default; use <a href="#bowtie-build-options-a"
3962   ><code
3963     >-a</code
3964     >/<code
3965     >--noauto</code
3966     ></a
3967   > to configure manually.</p
3968 ></td></tr><tr><td id="bowtie-build-options-bmaxdivn">
3969
3970
3971 <pre
3972 ><code
3973   >--bmaxdivn &lt;int&gt;
3974 </code
3975   ></pre
3976 ></td><td>
3977 <p
3978 >The maximum number of suffixes allowed in a block, expressed as a fraction of the length of the reference. Setting this option overrides any previous setting for <a href="#bowtie-build-options-bmax"
3979   ><code
3980     >--bmax</code
3981     ></a
3982   >, or <a href="#bowtie-build-options-bmaxdivn"
3983   ><code
3984     >--bmaxdivn</code
3985     ></a
3986   >. Default: <a href="#bowtie-build-options-bmaxdivn"
3987   ><code
3988     >--bmaxdivn</code
3989     ></a
3990   > 4. This is configured automatically by default; use <a href="#bowtie-build-options-a"
3991   ><code
3992     >-a</code
3993     >/<code
3994     >--noauto</code
3995     ></a
3996   > to configure manually.</p
3997 ></td></tr><tr><td id="bowtie-build-options-dcv">
3998
3999
4000 <pre
4001 ><code
4002   >--dcv &lt;int&gt;
4003 </code
4004   ></pre
4005 ></td><td>
4006 <p
4007 >Use <code
4008   >&lt;int&gt;</code
4009   > as the period for the difference-cover sample. A larger period yields less memory overhead, but may make suffix sorting slower, especially if repeats are present. Must be a power of 2 no greater than 4096. Default: 1024. This is configured automatically by default; use <a href="#bowtie-build-options-a"
4010   ><code
4011     >-a</code
4012     >/<code
4013     >--noauto</code
4014     ></a
4015   > to configure manually.</p
4016 ></td></tr><tr><td id="bowtie-build-options-nodc">
4017
4018
4019 <pre
4020 ><code
4021   >--nodc
4022 </code
4023   ></pre
4024 ></td><td>
4025 <p
4026 >Disable use of the difference-cover sample. Suffix sorting becomes quadratic-time in the worst case (where the worst case is an extremely repetitive reference). Default: off.</p
4027 ></td></tr><tr><td>
4028 <pre
4029 ><code
4030   >-r/--noref
4031 </code
4032   ></pre
4033 ></td><td>
4034 <p
4035 >Do not build the <code
4036   >NAME.3.ebwt</code
4037   > and <code
4038   >NAME.4.ebwt</code
4039   > portions of the index, which contain a bitpacked version of the reference sequences and are used for paired-end alignment.</p
4040 ></td></tr><tr><td>
4041 <pre
4042 ><code
4043   >-3/--justref
4044 </code
4045   ></pre
4046 ></td><td>
4047 <p
4048 >Build <em
4049   >only</em
4050   > the <code
4051   >NAME.3.ebwt</code
4052   > and <code
4053   >NAME.4.ebwt</code
4054   > portions of the index, which contain a bitpacked version of the reference sequences and are used for paired-end alignment.</p
4055 ></td></tr><tr><td id="bowtie-build-options-o">
4056 <pre
4057 ><code
4058   >-o/--offrate &lt;int&gt;
4059 </code
4060   ></pre
4061 ></td><td>
4062 <p
4063 >To map alignments back to positions on the reference sequences, it's necessary to annotate (&quot;mark&quot;) some or all of the <a href="http://en.wikipedia.org/wiki/Burrows-Wheeler_transform"
4064   >Burrows-Wheeler</a
4065   > rows with their corresponding location on the genome. <a href="#bowtie-build-options-o"
4066   ><code
4067     >-o</code
4068     >/<code
4069     >--offrate</code
4070     ></a
4071   > governs how many rows get marked: the indexer will mark every 2^<code
4072   >&lt;int&gt;</code
4073   > rows. Marking more rows makes reference-position lookups faster, but requires more memory to hold the annotations at runtime. The default is 5 (every 32nd row is marked; for human genome, annotations occupy about 340 megabytes).</p
4074 ></td></tr><tr><td>
4075 <pre
4076 ><code
4077   >-t/--ftabchars &lt;int&gt;
4078 </code
4079   ></pre
4080 ></td><td>
4081 <p
4082 >The ftab is the lookup table used to calculate an initial <a href="http://en.wikipedia.org/wiki/Burrows-Wheeler_transform"
4083   >Burrows-Wheeler</a
4084   > range with respect to the first <code
4085   >&lt;int&gt;</code
4086   > characters of the query. A larger <code
4087   >&lt;int&gt;</code
4088   > yields a larger lookup table but faster query times. The ftab has size 4^(<code
4089   >&lt;int&gt;</code
4090   >+1) bytes. The default setting is 10 (ftab is 4MB).</p
4091 ></td></tr><tr><td id="bowtie-build-options-ntoa">
4092 <pre
4093 ><code
4094   >--ntoa
4095 </code
4096   ></pre
4097 ></td><td>
4098 <p
4099 >Convert Ns in the reference sequence to As before building the index. By default, Ns are simply excluded from the index and <code
4100   >bowtie</code
4101   > will not report alignments that overlap them.</p
4102 ></td></tr><tr><td id="bowtie-build-options-big-little">
4103 <pre
4104 ><code
4105   >--big --little
4106 </code
4107   ></pre
4108 ></td><td>
4109 <p
4110 >Endianness to use when serializing integers to the index file. Default: little-endian (recommended for Intel- and AMD-based architectures).</p
4111 ></td></tr><tr><td id="bowtie-build-options-seed">
4112 <pre
4113 ><code
4114   >--seed &lt;int&gt;
4115 </code
4116   ></pre
4117 ></td><td>
4118 <p
4119 >Use <code
4120   >&lt;int&gt;</code
4121   > as the seed for pseudo-random number generator.</p
4122 ></td></tr><tr><td>
4123 <pre
4124 ><code
4125   >--cutoff &lt;int&gt;
4126 </code
4127   ></pre
4128 ></td><td>
4129 <p
4130 >Index only the first <code
4131   >&lt;int&gt;</code
4132   > bases of the reference sequences (cumulative across sequences) and ignore the rest.</p
4133 ></td></tr><tr><td>
4134 <pre
4135 ><code
4136   >-q/--quiet
4137 </code
4138   ></pre
4139 ></td><td>
4140 <p
4141 ><code
4142   >bowtie-build</code
4143   > is verbose by default. With this option <code
4144   >bowtie-build</code
4145   > will print only error messages.</p
4146 ></td></tr><tr><td>
4147 <pre
4148 ><code
4149   >-h/--help
4150 </code
4151   ></pre
4152 ></td><td>
4153 <p
4154 >Print usage information and quit.</p
4155 ></td></tr><tr><td>
4156 <pre
4157 ><code
4158   >--version
4159 </code
4160   ></pre
4161 ></td><td>
4162 <p
4163 >Print version information and quit.</p
4164 ></td></tr></table>
4165 <h1 id="the-bowtie-inspect-index-inspector"
4166 ><a href="#TOC"
4167   >The <code
4168     >bowtie-inspect</code
4169     > index inspector</a
4170   ></h1
4171 ><p
4172 ><code
4173   >bowtie-inspect</code
4174   > extracts information from a Bowtie index about what kind of index it is and what reference sequences were used to build it. When run without any options, the tool will output a FASTA file containing the sequences of the original references (with all non-<code
4175   >A</code
4176   >/<code
4177   >C</code
4178   >/<code
4179   >G</code
4180   >/<code
4181   >T</code
4182   > characters converted to <code
4183   >N</code
4184   >s). It can also be used to extract just the reference sequence names using the <a href="#bowtie-build-options-n"
4185   ><code
4186     >-n</code
4187     >/<code
4188     >--names</code
4189     ></a
4190   > option or a more verbose summary using the <a href="#bowtie-inspect-options-s"
4191   ><code
4192     >-s</code
4193     >/<code
4194     >--summary</code
4195     ></a
4196   > option.</p
4197 ><h2 id="command-line-2"
4198 ><a href="#TOC"
4199   >Command Line</a
4200   ></h2
4201 ><p
4202 >Usage:</p
4203 ><pre
4204 ><code
4205   >bowtie-inspect [options]* &lt;ebwt_base&gt;
4206 </code
4207   ></pre
4208 ><h3 id="main-arguments-2"
4209 ><a href="#TOC"
4210   >Main arguments</a
4211   ></h3
4212 ><table><tr><td>
4213 <pre
4214 ><code
4215   >&lt;ebwt_base&gt;
4216 </code
4217   ></pre
4218 ></td><td>
4219 <p
4220 >The basename of the index to be inspected. The basename is name of any of the index files but with the <code
4221   >.X.ebwt</code
4222   > or <code
4223   >.rev.X.ebwt</code
4224   > suffix omitted. <code
4225   >bowtie-inspect</code
4226   > first looks in the current directory for the index files, then looks in the <code
4227   >indexes</code
4228   > subdirectory under the directory where the currently-running <code
4229   >bowtie</code
4230   > executable is located, then looks in the directory specified in the <code
4231   >BOWTIE_INDEXES</code
4232   > environment variable.</p
4233 ></td></tr></table>
4234 <h3 id="options-2"
4235 ><a href="#TOC"
4236   >Options</a
4237   ></h3
4238 ><table><tr><td>
4239 <pre
4240 ><code
4241   >-a/--across &lt;int&gt;
4242 </code
4243   ></pre
4244 ></td><td>
4245 <p
4246 >When printing FASTA output, output a newline character every <code
4247   >&lt;int&gt;</code
4248   > bases (default: 60).</p
4249 ></td></tr><tr><td id="bowtie-build-options-n">
4250
4251
4252 <pre
4253 ><code
4254   >-n/--names
4255 </code
4256   ></pre
4257 ></td><td>
4258 <p
4259 >Print reference sequence names, one per line, and quit.</p
4260 ></td></tr><tr><td id="bowtie-inspect-options-s">
4261
4262
4263 <pre
4264 ><code
4265   >-s/--summary
4266 </code
4267   ></pre
4268 ></td><td>
4269 <p
4270 >Print a summary that includes information about index settings, as well as the names and lengths of the input sequences. The summary has this format:</p
4271 ><pre
4272 ><code
4273   >Colorspace  &lt;0 or 1&gt;
4274 SA-Sample   1 in &lt;sample&gt;
4275 FTab-Chars  &lt;chars&gt;
4276 Sequence-1  &lt;name&gt;  &lt;len&gt;
4277 Sequence-2  &lt;name&gt;  &lt;len&gt;
4278 ...
4279 Sequence-N  &lt;name&gt;  &lt;len&gt;
4280 </code
4281   ></pre
4282 ><p
4283 >Fields are separated by tabs.</p
4284 ></td></tr><tr><td id="bowtie-inspect-options-e">
4285
4286
4287 <pre
4288 ><code
4289   >-e/--ebwt-ref
4290 </code
4291   ></pre
4292 ></td><td>
4293 <p
4294 >By default, when <code
4295   >bowtie-inspect</code
4296   > is run without <a href="#bowtie-options-s"
4297   ><code
4298     >-s</code
4299     ></a
4300   > or <a href="#bowtie-options-n"
4301   ><code
4302     >-n</code
4303     ></a
4304   >, it recreates the reference nucleotide sequences using the bit-encoded reference nucleotides kept in the <code
4305   >.3.ebwt</code
4306   > and <code
4307   >.4.ebwt</code
4308   > index files. When <code
4309   >-e/--ebwt-ref</code
4310   > is specified, <code
4311   >bowtie-inspect</code
4312   > recreates the reference sequences from the Burrows-Wheeler-transformed reference sequence in the <code
4313   >.1.ebwt</code
4314   > file instead. The reference recreation process is much slower when <code
4315   >-e/--ebwt-ref</code
4316   > is specified. Also, when <code
4317   >-e/--ebwt-ref</code
4318   > is specified and the index is in colorspace, the reference is printed in colors (A=blue, C=green, G=orange, T=red).</p
4319 ></td></tr><tr><td>
4320 <pre
4321 ><code
4322   >-v/--verbose
4323 </code
4324   ></pre
4325 ></td><td>
4326 <p
4327 >Print verbose output (for debugging).</p
4328 ></td></tr><tr><td>
4329 <pre
4330 ><code
4331   >--version
4332 </code
4333   ></pre
4334 ></td><td>
4335 <p
4336 >Print version information and quit.</p
4337 ></td></tr><tr><td>
4338 <pre
4339 ><code
4340   >-h/--help
4341 </code
4342   ></pre
4343 ></td><td>
4344 <p
4345 >Print usage information and quit.</p
4346 ></td></tr></table>
4347
4348
4349 </body>
4350 </html>