update the manual page
This commit is contained in:
parent
1d7d8be9e8
commit
0380cf02bf
64
bwa.1
64
bwa.1
|
|
@ -56,10 +56,10 @@ Index database sequences in the FASTA format.
|
||||||
.B -c
|
.B -c
|
||||||
Build color-space index. The input fast should be in nucleotide space.
|
Build color-space index. The input fast should be in nucleotide space.
|
||||||
.TP
|
.TP
|
||||||
.B -p STR
|
.BI -p \ STR
|
||||||
Prefix of the output database [same as db filename]
|
Prefix of the output database [same as db filename]
|
||||||
.TP
|
.TP
|
||||||
.B -a STR
|
.BI -a \ STR
|
||||||
Algorithm for constructing BWT index. Available options are:
|
Algorithm for constructing BWT index. Available options are:
|
||||||
.RS
|
.RS
|
||||||
.TP
|
.TP
|
||||||
|
|
@ -95,47 +95,47 @@ differences are allowed in the whole sequence.
|
||||||
.B OPTIONS:
|
.B OPTIONS:
|
||||||
.RS
|
.RS
|
||||||
.TP 10
|
.TP 10
|
||||||
.B -n NUM
|
.BI -n \ NUM
|
||||||
Maximum edit distance if the value is INT, or the fraction of missing
|
Maximum edit distance if the value is INT, or the fraction of missing
|
||||||
alignments given 2% uniform base error rate if FLOAT. In the latter
|
alignments given 2% uniform base error rate if FLOAT. In the latter
|
||||||
case, the maximum edit distance is automatically chosen for different
|
case, the maximum edit distance is automatically chosen for different
|
||||||
read lengths. [0.04]
|
read lengths. [0.04]
|
||||||
.TP
|
.TP
|
||||||
.B -o INT
|
.BI -o \ INT
|
||||||
Maximum number of gap opens [1]
|
Maximum number of gap opens [1]
|
||||||
.TP
|
.TP
|
||||||
.B -e INT
|
.BI -e \ INT
|
||||||
Maximum number of gap extensions, -1 for k-difference mode (disallowing
|
Maximum number of gap extensions, -1 for k-difference mode (disallowing
|
||||||
long gaps) [-1]
|
long gaps) [-1]
|
||||||
.TP
|
.TP
|
||||||
.B -d INT
|
.BI -d \ INT
|
||||||
Disallow a long deletion within INT bp towards the 3'-end [16]
|
Disallow a long deletion within INT bp towards the 3'-end [16]
|
||||||
.TP
|
.TP
|
||||||
.B -i INT
|
.BI -i \ INT
|
||||||
Disallow an indel within INT bp towards the ends [5]
|
Disallow an indel within INT bp towards the ends [5]
|
||||||
.TP
|
.TP
|
||||||
.B -l INT
|
.BI -l \ INT
|
||||||
Take the first INT subsequence as seed. If INT is larger than the query
|
Take the first INT subsequence as seed. If INT is larger than the query
|
||||||
sequence, seeding will be disabled. For long reads, this option is
|
sequence, seeding will be disabled. For long reads, this option is
|
||||||
typically ranged from 25 to 35 for `-k 2'. [inf]
|
typically ranged from 25 to 35 for `-k 2'. [inf]
|
||||||
.TP
|
.TP
|
||||||
.B -k INT
|
.BI -k \ INT
|
||||||
Maximum edit distance in the seed [2]
|
Maximum edit distance in the seed [2]
|
||||||
.TP
|
.TP
|
||||||
.B -t INT
|
.BI -t \ INT
|
||||||
Number of threads (multi-threading mode) [1]
|
Number of threads (multi-threading mode) [1]
|
||||||
.TP
|
.TP
|
||||||
.B -M INT
|
.BI -M \ INT
|
||||||
Mismatch penalty. BWA will not search for suboptimal hits with a score
|
Mismatch penalty. BWA will not search for suboptimal hits with a score
|
||||||
lower than (bestScore-misMsc). [3]
|
lower than (bestScore-misMsc). [3]
|
||||||
.TP
|
.TP
|
||||||
.B -O INT
|
.BI -O \ INT
|
||||||
Gap open penalty [11]
|
Gap open penalty [11]
|
||||||
.TP
|
.TP
|
||||||
.B -E INT
|
.BI -E \ INT
|
||||||
Gap extension penalty [4]
|
Gap extension penalty [4]
|
||||||
.TP
|
.TP
|
||||||
.B -R INT
|
.BI -R \ INT
|
||||||
Proceed with suboptimal alignments if there are no more than INT equally
|
Proceed with suboptimal alignments if there are no more than INT equally
|
||||||
best hits. This option only affects paired-end mapping. Increasing this
|
best hits. This option only affects paired-end mapping. Increasing this
|
||||||
threshold helps to improve the pairing accuracy at the cost of speed,
|
threshold helps to improve the pairing accuracy at the cost of speed,
|
||||||
|
|
@ -150,11 +150,22 @@ Disable iterative search. All hits with no more than
|
||||||
.I maxDiff
|
.I maxDiff
|
||||||
differences will be found. This mode is much slower than the default.
|
differences will be found. This mode is much slower than the default.
|
||||||
.TP
|
.TP
|
||||||
.B -q INT
|
.BI -q \ INT
|
||||||
Parameter for read trimming. BWA trims a read down to
|
Parameter for read trimming. BWA trims a read down to
|
||||||
argmax_x{\\sum_{i=x+1}^l(INT-q_i)} if q_l<INT where l is the original
|
argmax_x{\\sum_{i=x+1}^l(INT-q_i)} if q_l<INT where l is the original
|
||||||
read length. [0]
|
read length. [0]
|
||||||
.TP
|
.TP
|
||||||
|
.B -I
|
||||||
|
The input is in the Illumina 1.3+ read format (quality equals ASCII-64).
|
||||||
|
.TP
|
||||||
|
.BI -B \ INT
|
||||||
|
Length of barcode starting from the 5'-end. When
|
||||||
|
.I INT
|
||||||
|
is positive, the barcode of each read will be trimmed before mapping and will
|
||||||
|
be written at the
|
||||||
|
.B BC
|
||||||
|
SAM tag. For paired-end reads, the barcode from both ends are concatenated. [0]
|
||||||
|
.TP
|
||||||
.B -b
|
.B -b
|
||||||
Specify the input read sequence file is the BAM format. For paired-end
|
Specify the input read sequence file is the BAM format. For paired-end
|
||||||
data, two ends in a pair must be grouped together and options
|
data, two ends in a pair must be grouped together and options
|
||||||
|
|
@ -256,41 +267,41 @@ Align query sequences in the <in.fq> file.
|
||||||
.B OPTIONS:
|
.B OPTIONS:
|
||||||
.RS
|
.RS
|
||||||
.TP 10
|
.TP 10
|
||||||
.B -a INT
|
.BI -a \ INT
|
||||||
Score of a match [1]
|
Score of a match [1]
|
||||||
.TP
|
.TP
|
||||||
.B -b INT
|
.BI -b \ INT
|
||||||
Mismatch penalty [3]
|
Mismatch penalty [3]
|
||||||
.TP
|
.TP
|
||||||
.B -q INT
|
.BI -q \ INT
|
||||||
Gap open penalty [5]
|
Gap open penalty [5]
|
||||||
.TP
|
.TP
|
||||||
.B -r INT
|
.BI -r \ INT
|
||||||
Gap extension penalty. The penalty for a contiguous gap of size k is
|
Gap extension penalty. The penalty for a contiguous gap of size k is
|
||||||
q+k*r. [2]
|
q+k*r. [2]
|
||||||
.TP
|
.TP
|
||||||
.B -t INT
|
.BI -t \ INT
|
||||||
Number of threads in the multi-threading mode [1]
|
Number of threads in the multi-threading mode [1]
|
||||||
.TP
|
.TP
|
||||||
.B -w INT
|
.BI -w \ INT
|
||||||
Band width in the banded alignment [33]
|
Band width in the banded alignment [33]
|
||||||
.TP
|
.TP
|
||||||
.B -T INT
|
.BI -T \ INT
|
||||||
Minimum score threshold divided by a [37]
|
Minimum score threshold divided by a [37]
|
||||||
.TP
|
.TP
|
||||||
.B -c FLOAT
|
.BI -c \ FLOAT
|
||||||
Coefficient for threshold adjustment according to query length. Given an
|
Coefficient for threshold adjustment according to query length. Given an
|
||||||
l-long query, the threshold for a hit to be retained is
|
l-long query, the threshold for a hit to be retained is
|
||||||
a*max{T,c*log(l)}. [5.5]
|
a*max{T,c*log(l)}. [5.5]
|
||||||
.TP
|
.TP
|
||||||
.B -z INT
|
.BI -z \ INT
|
||||||
Z-best heuristics. Higher -z increases accuracy at the cost of speed. [1]
|
Z-best heuristics. Higher -z increases accuracy at the cost of speed. [1]
|
||||||
.TP
|
.TP
|
||||||
.B -s INT
|
.BI -s \ INT
|
||||||
Maximum SA interval size for initiating a seed. Higher -s increases
|
Maximum SA interval size for initiating a seed. Higher -s increases
|
||||||
accuracy at the cost of speed. [3]
|
accuracy at the cost of speed. [3]
|
||||||
.TP
|
.TP
|
||||||
.B -N INT
|
.BI -N \ INT
|
||||||
Minimum number of seeds supporting the resultant alignment to skip
|
Minimum number of seeds supporting the resultant alignment to skip
|
||||||
reverse alignment. [5]
|
reverse alignment. [5]
|
||||||
.RE
|
.RE
|
||||||
|
|
@ -361,6 +372,7 @@ _
|
||||||
NM Edit distance
|
NM Edit distance
|
||||||
MD Mismatching positions/bases
|
MD Mismatching positions/bases
|
||||||
AS Alignment score
|
AS Alignment score
|
||||||
|
BC Barcode sequence
|
||||||
_
|
_
|
||||||
X0 Number of best hits
|
X0 Number of best hits
|
||||||
X1 Number of suboptimal hits found by BWA
|
X1 Number of suboptimal hits found by BWA
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue