bowtie2-align-l1
Ultrafast and memory-efficient backend tool for aligning sequencing reads to long reference sequences
Overview
Bowtie 2 version 2.5.4 by Ben Langmead ([email protected], www.cs.jhu.edu/~langmea)
Usage
bowtie2-align [options]* -x <bt2-idx> {-1 <m1> -2 <m2> | -U <r> | --interleaved <i> | -b <bam>} [-S <sam>]
- <bt2-idx>
-
Index filename prefix (minus trailing .X.bt2l). NOTE: Bowtie 1 and Bowtie 2 indexes are not compatible.
- <m1>
-
Files with #1 mates, paired with files in <m2>.
- <m2>
-
Files with #2 mates, paired with files in <m1>.
- <r>
-
Files with unpaired reads.
- <i>
-
Files with interleaved paired-end FASTQ/FASTA reads
- <bam>
-
Files are unaligned BAM sorted by read name.
- <sam>
-
File for SAM output (default: stdout)
-
<m1>, <m2>, <r> can be comma-separated lists (no whitespace) and can be specified many times. E.g. '-U file1.fq,file2.fq
-Ufile3.fq'.
OPTIONS (defaults in parentheses)
Input:
-q-
query input files are FASTQ .fq/.fastq (default)
--tab5-
query input files are TAB5 .tab5
--tab6-
query input files are TAB6 .tab6
--qseq-
query input files are in Illumina's qseq format
-f-
query input files are (multi-)FASTA .fa/.mfa
-r-
query input files are raw one-sequence-per-line
-Fk:<int>,i:<int> query input files are continuous FASTA where reads-
are substrings (k-mers) extracted from the FASTA file and aligned at offsets 1, 1+i, 1+2i ... end of reference
-c-
<m1>, <m2>, <r> are sequences themselves, not files
-s/--skip <int>-
skip the first <int> reads/pairs in the input (none)
-u/--upto <int>-
stop after first <int> reads/pairs (no limit)
-5/--trim5 <int>-
trim <int> bases from 5'/left end of reads (0)
-3/--trim3 <int>-
trim <int> bases from 3'/right end of reads (0)
--trim-to[3:|5:]<int> trim reads exceeding <int> bases from either 3' or 5' end-
If the read end is not specified then it defaults to 3 (0)
--phred33-
qualities are Phred+33 (default)
--phred64-
qualities are Phred+64
--int-quals-
qualities encoded as space-delimited integers
Presets:
Same as:
-
For
--end-to-end:
--very-fast -D 5 -R 1 -N 0 -L 22 -i S,0,2.50
--fast -D 10 -R 2 -N 0 -L 22 -i S,0,2.50
--sensitive -D 15 -R 2 -N 0 -L 22 -i S,1,1.15 (default)
--very-sensitive -D 20 -R 3 -N 0 -L 20 -i S,1,0.50
-
For
--local:
--very-fast-local -D 5 -R 1 -N 0 -L 25 -i S,1,2.00
--fast-local -D 10 -R 2 -N 0 -L 22 -i S,1,1.75
--sensitive-local -D 15 -R 2 -N 0 -L 20 -i S,1,0.75 (default)
--very-sensitive-local -D 20 -R 3 -N 0 -L 20 -i S,1,0.50
Alignment:
-N<int>-
max # mismatches in seed alignment; can be 0 or 1 (0)
-L<int>-
length of seed substrings; must be >3, <32 (22)
-i<func>-
interval between seed substrings w/r/t read len (S,1,1.15)
--n-ceil<func>-
func for max # non-A/C/G/Ts permitted in aln (L,0,0.15)
--dpad<int>-
include <int> extra ref chars on sides of DP table (15)
--gbar<int>-
disallow gaps within <int> nucs of read extremes (4)
--ignore-quals-
treat all quality values as 30 on Phred scale (off)
--nofw-
do not align forward (original) version of read (off)
--norc-
do not align reverse-complement version of read (off)
--no-1mm-upfront-
do not allow 1 mismatch alignments before attempting to scan for the optimal seeded alignments
--end-to-end-
entire read must align; no clipping (on)
-
OR
--local-
local alignment; ends might be soft clipped (off)
Scoring:
|
match bonus (0 for |
|---|---|
|
max penalty for mismatch; lower qual = lower penalty (6) |
|
penalty for non-A/C/G/Ts in read/ref (1) |
|
read gap open, extend penalties (5,3) |
|
reference gap open, extend penalties (5,3) |
|
(G,20,8 for local, L,-0.6,-0.6 for end-to-end) |
Reporting:
(default)
|
look for multiple alignments, report best, with MAPQ |
|---|---|
|
OR |
|
|
report up to <int> alns per read; MAPQ not meaningful |
|
OR |
|
|
report all alignments; very slow, MAPQ not meaningful |
Effort:
|
give up extending after <int> failed extends in a row (15) |
|---|---|
|
for reads w/ repetitive seeds, try <int> sets of seeds (2) |
|
Paired-end: |
|
|
minimum fragment length (0) |
|
maximum fragment length (500) |
--fr/--rf/--ff -1, -2 mates align fw/rev, rev/fw, fw/fw (--fr)
--no-mixed-
suppress unpaired alignments for paired reads
--no-discordant-
suppress discordant alignments for paired reads
--dovetail-
concordant when mates extend past each other
--no-contain-
not concordant when one mate alignment contains other
--no-overlap-
not concordant when mates overlap at all
-
BAM:
--align-paired-reads-
Bowtie2 will, by default, attempt to align unpaired BAM reads. Use this option to align paired-end reads instead.
--preserve-tags-
Preserve tags from the original BAM record by appending them to the end of the corresponding SAM output.
Output:
-t/--time-
print wall-clock time taken by search phases
--quiet-
print nothing to stderr except serious errors
--met-file<path>-
send metrics to file at <path> (off)
--met-stderr-
send metrics to stderr (off)
--met<int>-
report internal counters & metrics every <int> secs (1)
--no-unal-
suppress SAM records for unaligned reads
--no-head-
suppress header lines, i.e. lines starting with @
--no-sq-
suppress @SQ header lines
--rg-id<text>-
set read group id, reflected in @RG line and RG:Z: opt field
--rg<text>-
add <text> ("lab:value") to @RG line of SAM header. Note: @RG line only printed when
--rg-idis set.
--omit-sec-seq-
put '*' in SEQ and QUAL fields for secondary alignments.
--sam-no-qname-trunc-
Suppress standard behavior of truncating readname at first whitespace at the expense of generating non-standard SAM.
--xeq-
Use '='/'X', instead of 'M,' to specify matches/mismatches in SAM record.
--soft-clipped-unmapped-tlen-
Exclude soft-clipped bases when reporting TLEN.
--sam-append-comment-
Append FASTA/FASTQ comment to SAM record.
--sam-opt-config<config>-
Use <config>, example '-MD,YP,-AS', to toggle SAM Optional fields.
Performance:
-p/--threads <int> number of alignment threads to launch (1)
|
force SAM output order to match order of input reads |
|---|---|
|
use memory-mapped I/O for index; many 'bowtie's can share |
Other:
|
filter out reads that are bad according to QSEQ filter |
|---|---|
|
seed for random number generator (0) |
|
seed rand. gen. arbitrarily instead of using read attributes |
|
print version information and quit |
|
print this usage message |
Releases
6 releases since Debian 8 (Jessie); the text changed 5 times.
--dpad until Debian 8 (Jessie);
--end-to-end until Debian 8 (Jessie);
--gbar until Debian 8 (Jessie);
--ignore-quals until Debian 8 (Jessie);
--int-quals until Debian 8 (Jessie);
--local until Debian 8 (Jessie);
--ma until Debian 8 (Jessie);
--met until Debian 8 (Jessie);
--met-file until Debian 8 (Jessie);
--met-stderr until Debian 8 (Jessie);
--mm until Debian 8 (Jessie);
--mp until Debian 8 (Jessie);
--n-ceil until Debian 8 (Jessie);
--no-1mm-upfront until Debian 8 (Jessie);
--no-contain until Debian 8 (Jessie);
--no-discordant until Debian 8 (Jessie);
--no-dovetail until Debian 8 (Jessie);
--no-head until Debian 8 (Jessie);
--no-mixed until Debian 8 (Jessie);
--no-overlap until Debian 8 (Jessie);
--no-sq until Debian 8 (Jessie);
--no-unal until Debian 8 (Jessie);
--nofw until Debian 8 (Jessie);
--norc until Debian 8 (Jessie);
--np until Debian 8 (Jessie);
--omit-sec-seq until Debian 8 (Jessie);
--phred33 until Debian 8 (Jessie);
--phred64 until Debian 8 (Jessie);
--qc-filter until Debian 8 (Jessie);
--qseq until Debian 8 (Jessie);
--quiet until Debian 8 (Jessie);
--rdg until Debian 8 (Jessie);
--reorder until Debian 8 (Jessie);
--rfg until Debian 8 (Jessie);
--rg until Debian 8 (Jessie);
--rg-id until Debian 8 (Jessie);
--seed until Debian 8 (Jessie);
--version until Debian 8 (Jessie);
-D until Debian 8 (Jessie);
-L until Debian 8 (Jessie);
-N until Debian 8 (Jessie);
-R until Debian 8 (Jessie);
-c until Debian 8 (Jessie);
-f until Debian 8 (Jessie);
-i until Debian 8 (Jessie);
-k until Debian 8 (Jessie);
-q until Debian 8 (Jessie);
-r until Debian 8 (Jessie).