annotate bwa-0.7.9a/NEWS.md @ 0:ce5a8082bbb8 draft

Uploaded
author xilinxu
date Thu, 14 Aug 2014 02:16:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1 Release 0.7.9 (19 May, 2014)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
2 ----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
3
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
4 This release brings several major changes to BWA-MEM. Notably, BWA-MEM now
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
5 formally supports PacBio read-to-reference alignment and experimentally supports
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
6 PacBio read-to-read alignment. BWA-MEM also runs faster at a minor cost of
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
7 accuracy. The speedup is more significant when GRCh38 is in use. More
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
8 specifically:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
9
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
10 * Support PacBio subread-to-reference alignment. Although older BWA-MEM works
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
11 with PacBio data in principle, the resultant alignments are frequently
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
12 fragmented. In this release, we fine tuned existing methods and introduced
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
13 new heuristics to improve PacBio alignment. These changes are not used by
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
14 default. Users need to add option "-x pacbio" to enable the feature.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
15
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
16 * Support PacBio subread-to-subread alignment (EXPERIMENTAL). This feature is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
17 enabled with option "-x pbread". In this mode, the output only gives the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
18 overlapping region between a pair of reads without detailed alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
19
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
20 * Output alternative hits in the XA tag if there are not so many of them. This
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
21 is a BWA-backtrack feature.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
22
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
23 * Support mapping to ALT contigs in GRCh38 (EXPERIMENTAL). We provide a script
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
24 to postprocess hits in the XA tag to adjust the mapping quality and generate
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
25 new primary alignments to all overlapping ALT contigs. We would *NOT*
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
26 recommend this feature for production uses.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
27
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
28 * Improved alignments to many short reference sequences. Older BWA-MEM may
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
29 generate an alignment bridging two or more adjacent reference sequences.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
30 Such alignments are split at a later step as postprocessing. This approach
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
31 is complex and does not always work. This release forbids these alignments
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
32 from the very beginning. BWA-MEM should not produce an alignment bridging
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
33 two or more reference sequences any more.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
34
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
35 * Reduced the maximum seed occurrence from 10000 to 500. Reduced the maximum
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
36 rounds of Smith-Waterman mate rescue from 100 to 50. Added a heuristic to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
37 lower the mapping quality if a read contains seeds with excessive
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
38 occurrences. These changes make BWA-MEM faster at a minor cost of accuracy
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
39 in highly repetitive regions.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
40
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
41 * Added an option "-Y" to use soft clipping for supplementary alignments.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
42
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
43 * Bugfix: incomplete alignment extension in corner cases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
44
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
45 * Bugfix: integer overflow when aligning long query sequences.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
46
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
47 * Bugfix: chain score is not computed correctly (almost no practical effect)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
48
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
49 * General code cleanup
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
50
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
51 * Added FAQs to README
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
52
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
53 Changes in BWA-backtrack:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
54
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
55 * Bugfix: a segmentation fault when an alignment stands out of the end of the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
56 last chromosome.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
57
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
58 (0.7.9: 19 May 2014, r783)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
59
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
60
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
61
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
62 Release 0.7.8 (31 March, 2014)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
63 ------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
64
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
65 Changes in BWA-MEM:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
66
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
67 * Bugfix: off-diagonal X-dropoff (option -d) not working as intended.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
68 Short-read alignment is not affected.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
69
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
70 * Bugfix: unnecessarily large bandwidth used during global alignment,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
71 which reduces the mapping speed by -5% for short reads. Results are not
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
72 affected.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
73
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
74 * Bugfix: when the matching score is not one, paired-end mapping quality is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
75 inaccurate.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
76
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
77 * When the matching score (option -A) is changed, scale all score-related
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
78 options accordingly unless overridden by users.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
79
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
80 * Allow to specify different gap open (or extension) penalties for deletions
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
81 and insertions separately.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
82
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
83 * Allow to specify the insert size distribution.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
84
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
85 * Better and more detailed debugging information.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
86
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
87 With the default setting, 0.7.8 and 0.7.7 gave identical output on one million
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
88 100bp read pairs.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
89
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
90 (0.7.8: 31 March 2014, r455)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
91
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
92
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
93
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
94 Release 0.7.7 (25 Feburary, 2014)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
95 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
96
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
97 This release fixes incorrect MD tags in the BWA-MEM output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
98
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
99 A note about short-read mapping to GRCh38. The new human reference genome
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
100 GRCh38 contains 60Mbp program generated alpha repeat arrays, some of which are
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
101 hard masked as they cannot be localized. These highly repetitive arrays make
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
102 BWA-MEM -50% slower. If you are concerned with the performance of BWA-MEM, you
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
103 may consider to use option "-c2000 -m50". On simulated data, this setting helps
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
104 the performance at a very minor cost on accuracy. I may consider to change the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
105 default in future releases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
106
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
107 (0.7.7: 25 Feburary 2014, r441)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
108
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
109
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
110
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
111 Release 0.7.6 (31 Januaray, 2014)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
112 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
113
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
114 Changes in BWA-MEM:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
115
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
116 * Changed the way mapping quality is estimated. The new method tends to give
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
117 the same alignment a higher mapping quality. On paired-end reads, the change
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
118 is minor as with pairing, the mapping quality is usually high. For short
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
119 single-end reads, the difference is considerable.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
120
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
121 * Improved load balance when many threads are spawned. However, bwa-mem is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
122 still not very thread efficient, probably due to the frequent heap memory
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
123 allocation. Further improvement is a little difficult and may affect the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
124 code stability.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
125
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
126 * Allow to use different clipping penalties for 5'- and 3'-ends. This helps
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
127 when we do not want to clip one end.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
128
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
129 * Print the @PG line, including the command line options.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
130
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
131 * Improved the band width estimate: a) fixed a bug causing the band
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
132 width extimated from extension not used in the final global alignment; b)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
133 try doubled band width if the global alignment score is smaller.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
134 Insufficient band width leads to wrong CIGAR and spurious mismatches/indels.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
135
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
136 * Added a new option -D to fine tune a heuristic on dropping suboptimal hits.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
137 Reducing -D increases accuracy but decreases the mapping speed. If unsure,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
138 leave it to the default.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
139
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
140 * Bugfix: for a repetitive single-end read, the reported hit is not randomly
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
141 distributed among equally best hits.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
142
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
143 * Bugfix: missing paired-end hits due to unsorted list of SE hits.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
144
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
145 * Bugfix: incorrect CIGAR caused by a defect in the global alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
146
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
147 * Bugfix: incorrect CIGAR caused by failed SW rescue.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
148
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
149 * Bugfix: alignments largely mapped to the same position are regarded to be
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
150 distinct from each other, which leads to underestimated mapping quality.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
151
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
152 * Added the MD tag.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
153
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
154 There are no changes to BWA-backtrack in this release. However, it has a few
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
155 known issues yet to be fixed. If you prefer BWA-track, It is still advised to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
156 use bwa-0.6.x.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
157
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
158 While I developed BWA-MEM, I also found a few issues with BWA-SW. It is now
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
159 possible to improve BWA-SW with the lessons learned from BWA-MEM. However, as
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
160 BWA-MEM is usually better, I will not improve BWA-SW until I find applications
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
161 where BWA-SW may excel.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
162
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
163 (0.7.6: 31 January 2014, r432)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
164
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
165
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
166
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
167 Release 0.7.5a (30 May, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
168 -----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
169
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
170 Fixed a bug in BWA-backtrack which leads to off-by-one mapping errors in rare
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
171 cases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
172
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
173 (0.7.5a: 30 May 2013, r405)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
174
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
175
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
176
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
177 Release 0.7.5 (29 May, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
178 ----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
179
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
180 Changes in all components:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
181
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
182 * Improved error checking on memory allocation and file I/O. Patches provided
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
183 by Rob Davies.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
184
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
185 * Updated README.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
186
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
187 * Bugfix: return code is zero upon errors.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
188
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
189 Changes in BWA-MEM:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
190
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
191 * Changed the way a chimeric alignment is reported (conforming to the upcoming
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
192 SAM spec v1.5). With 0.7.5, if the read has a chimeric alignment, the paired
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
193 or the top hit uses soft clipping and is marked with neither 0x800 nor 0x100
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
194 bits. All the other hits part of the chimeric alignment will use hard
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
195 clipping and be marked with 0x800 if option "-M" is not in use, or marked
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
196 with 0x100 otherwise.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
197
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
198 * Other hits part of a chimeric alignment are now reported in the SA tag,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
199 conforming to the SAM spec v1.5.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
200
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
201 * Better method for resolving an alignment bridging two or more short
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
202 reference sequences. The current strategy maps the query to the reference
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
203 sequence that covers the middle point of the alignment. For most
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
204 applications, this change has no effects.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
205
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
206 Changes in BWA-backtrack:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
207
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
208 * Added a magic number to .sai files. This prevents samse/sampe from reading
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
209 corrupted .sai (e.g. a .sai file containing LSF log) or incompatible .sai
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
210 generated by a different version of bwa.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
211
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
212 * Bugfix: alignments in the XA:Z: tag were wrong.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
213
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
214 * Keep track of #ins and #del during backtracking. This simplifies the code
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
215 and reduces errors in rare corner cases. I should have done this in the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
216 early days of bwa.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
217
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
218 In addition, if you use BWA-MEM or the fastmap command of BWA, please cite:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
219
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
220 - Li H. (2013) Aligning sequence reads, clone sequences and assembly contigs
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
221 with BWA-MEM. arXiv:1303.3997v2 [q-bio.GN].
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
222
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
223 Thank you.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
224
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
225 (0.7.5: 29 May 2013, r404)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
226
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
227
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
228
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
229 Release 0.7.4 (23 April, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
230 ------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
231
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
232 This is a bugfix release. Most of bugs are considered to be minor which only
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
233 occur very rarely.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
234
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
235 * Bugfix: wrong CIGAR when a query sequence bridges three or more target
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
236 sequences. This only happens when aligning reads to short assembly contigs.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
237
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
238 * Bugfix: leading "D" operator in CIGAR.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
239
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
240 * Extend more seeds for better alignment around tandem repeats. This is also
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
241 a cause of the leading "D" operator in CIGAR.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
242
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
243 * Bugfix: SSE2-SSW may occasionally find incorrect query starting position
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
244 around tandem repeat. This will lead to a suboptimal CIGAR in BWA-MEM and
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
245 a wrong CIGAR in BWA.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
246
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
247 * Bugfix: clipping penalty does not work as is intended when there is a gap
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
248 towards the end of a read.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
249
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
250 * Fixed an issue caused by a bug in the libc from Mac/Darwin. In Darwin,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
251 fread() is unable to read a data block longer than 2GB due to an integer
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
252 overflow bug in its implementation.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
253
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
254 Since version 0.7.4, BWA-MEM is considered to reach similar stability to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
255 BWA-backtrack for short-read mapping.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
256
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
257 (0.7.4: 23 April, r385)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
258
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
259
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
260
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
261 Release 0.7.3a (15 March, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
262 -------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
263
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
264 In 0.7.3, the wrong CIGAR bug was only fixed in one scenario, but not fixed
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
265 in another corner case.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
266
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
267 (0.7.3a: 15 March 2013, r367)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
268
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
269
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
270
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
271 Release 0.7.3 (15 March, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
272 ------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
273
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
274 Changes to BWA-MEM:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
275
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
276 * Bugfix: pairing score is inaccurate when option -A does not take the default
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
277 value. This is a very minor issue even if it happens.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
278
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
279 * Bugfix: occasionally wrong CIGAR. This happens when in the alignment there
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
280 is a 1bp deletion and a 1bp insertion which are close to the end of the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
281 reads, and there are no other substitutions or indels. BWA-MEM would not do
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
282 a gapped alignment due to the bug.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
283
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
284 * New feature: output other non-overlapping alignments in the XP tag such that
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
285 we can see the entire picture of alignment from one SAM line. XP gives the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
286 position, CIGAR, NM and mapQ of each aligned subsequence of the query.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
287
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
288 BWA-MEM has been used to align -300Gbp 100-700bp SE/PE reads. SNP/indel calling
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
289 has also been evaluated on part of these data. BWA-MEM generally gives better
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
290 pre-filtered SNP calls than BWA. No significant issues have been observed since
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
291 0.7.2, though minor improvements or bugs (e.g. the bug fixed in this release)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
292 are still possible. If you find potential issues, please send bug reports to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
293 <bio-bwa-help@lists.sourceforge.net> (free registration required).
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
294
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
295 In addition, more detailed description of the BWA-MEM algorithm can be found at
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
296 <https://github.com/lh3/mem-paper>.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
297
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
298 (0.7.3: 15 March 2013, r366)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
299
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
300
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
301
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
302 Release 0.7.2 (9 March, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
303 -----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
304
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
305 Emergent bug fix: 0.7.0 and 0.7.1 give a wrong sign to TLEN. In addition,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
306 flagging 'properly paired' also gets improved a little.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
307
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
308 (0.7.2: 9 March 2013, r351)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
309
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
310
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
311
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
312 Release 0.7.1 (8 March, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
313 -----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
314
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
315 Changes to BWA-MEM:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
316
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
317 * Bugfix: rare segmentation fault caused by a partial hit to the end of the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
318 last sequence.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
319
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
320 * Bugfix: occasional mis-pairing given an interleaved fastq.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
321
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
322 * Bugfix: wrong mate information when the mate is unmapped. SAM generated by
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
323 BWA-MEM can now be validated with Picard.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
324
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
325 * Improved the performance and accuracy for ultra-long query sequences.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
326 Short-read alignment is not affected.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
327
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
328 Changes to other components:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
329
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
330 * In BWA-backtrack and BWA-SW, replaced the code for global alignment,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
331 Smith-Waterman and SW extension. The performance and accuracy of the two
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
332 algorithms stay the same.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
333
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
334 * Added an experimental subcommand to merge overlapping paired ends. The
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
335 algorithm is very conservative: it may miss true overlaps but rarely makes
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
336 mistakes.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
337
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
338 An important note is that like BWA-SW, BWA-MEM may output multiple primary
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
339 alignments for a read, which may cause problems to some tools. For aligning
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
340 sequence reads, it is advised to use '-M' to flag extra hits as secondary. This
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
341 option is not the default because multiple primary alignments are theoretically
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
342 possible in sequence alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
343
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
344 (0.7.1: 8 March 2013, r347)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
345
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
346
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
347
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
348 Beta Release 0.7.0 (28 Feburary, 2013)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
349 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
350
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
351 This release comes with a new alignment algorithm, BWA-MEM, for 70bp-1Mbp query
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
352 sequences. BWA-MEM essentially seeds alignments with a variant of the fastmap
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
353 algorithm and extends seeds with banded affine-gap-penalty dynamic programming
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
354 (i.e. the Smith-Waterman-Gotoh algorithm). For typical Illumina 100bp reads or
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
355 longer low-divergence query sequences, BWA-MEM is about twice as fast as BWA
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
356 and BWA-SW and is more accurate. It also supports split alignments like BWA-SW
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
357 and may optionally output multiple hits like BWA. BWA-MEM does not guarantee
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
358 to find hits within a certain edit distance, but BWA is not efficient for such
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
359 task given longer reads anyway, and the edit-distance criterion is arguably
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
360 not as important in long-read alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
361
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
362 In addition to the algorithmic improvements, BWA-MEM also implements a few
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
363 handy features in practical aspects:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
364
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
365 1. BWA-MEM automatically switches between local and glocal (global wrt reads;
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
366 local wrt reference) alignment. It reports the end-to-end glocal alignment
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
367 if the glocal alignment is not much worse than the optimal local alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
368 Glocal alignment reduces reference bias.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
369
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
370 2. BWA-MEM automatically infers pair orientation from a batch of single-end
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
371 alignments. It allows more than one orientations if there are sufficient
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
372 supporting reads. This feature has not been tested on reads from Illumina
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
373 jumping library yet. (EXPERIMENTAL)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
374
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
375 3. BWA-MEM optionally takes one interleaved fastq for paired-end mapping. It
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
376 is possible to convert a name-sorted BAM to an interleaved fastq on the fly
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
377 and feed the data stream to BWA-MEM for mapping.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
378
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
379 4. BWA-MEM optionally copies FASTA/Q comments to the final SAM output, which
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
380 helps to transfer individual read annotations to the output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
381
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
382 5. BWA-MEM supports more advanced piping. Users can now run:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
383 (bwa mem ref.fa '<bzcat r1.fq.bz2' '<bzcat r2.fq.bz2') to map bzip'd read
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
384 files without replying on bash features.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
385
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
386 6. BWA-MEM provides a few basic APIs for single-end mapping. The 'example.c'
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
387 program in the source code directory implements a full single-end mapper in
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
388 50 lines of code.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
389
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
390 The BWA-MEM algorithm is in the beta phase. It is not advised to use BWA-MEM
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
391 for production use yet. However, when the implementation becomes stable after a
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
392 few release cycles, existing BWA users are recommended to migrate to BWA-MEM
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
393 for 76bp or longer Illumina reads and long query sequences. The original BWA
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
394 short-read algorithm will not deliver satisfactory results for 150bp+ Illumina
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
395 reads. Change of mappers will be necessary sooner or later.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
396
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
397 (0.7.0 beta: 28 Feburary 2013, r313)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
398
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
399
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
400
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
401 Release 0.6.2 (19 June, 2012)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
402 -----------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
403
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
404 This is largely a bug-fix release. Notable changes in BWA-short and BWA-SW:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
405
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
406 * Bugfix: BWA-SW may give bad alignments due to incorrect band width.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
407
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
408 * Bugfix: A segmentation fault due to an out-of-boundary error. The fix is a
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
409 temporary solution. The real cause has not been identified.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
410
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
411 * Attempt to read index from prefix.64.bwt, such that the 32-bit and 64-bit
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
412 index can coexist.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
413
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
414 * Added options '-I' and '-S' to control BWA-SW pairing.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
415
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
416 (0.6.2: 19 June 2012, r126)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
417
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
418
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
419
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
420 Release 0.6.1 (28 November, 2011)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
421 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
422
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
423 Notable changes to BWA-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
424
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
425 * Bugfix: duplicated alternative hits in the XA tag.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
426
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
427 * Bugfix: when trimming enabled, bwa-aln trims 1bp less.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
428
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
429 * Disabled the color-space alignment. 0.6.x is not working with SOLiD reads at
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
430 present.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
431
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
432 Notable changes to BWA-SW:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
433
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
434 * Bugfix: segfault due to excessive ambiguous bases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
435
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
436 * Bugfix: incorrect mate position in the SE mode.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
437
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
438 * Bugfix: rare segfault in the PE mode
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
439
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
440 * When macro _NO_SSE2 is in use, fall back to the standard Smith-Waterman
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
441 instead of SSE2-SW.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
442
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
443 * Optionally mark split hits with lower alignment scores as secondary.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
444
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
445 Changes to fastmap:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
446
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
447 * Bugfix: infinite loop caused by ambiguous bases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
448
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
449 * Optionally output the query sequence.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
450
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
451 (0.6.1: 28 November 2011, r104)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
452
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
453
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
454
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
455 Release 0.5.10 and 0.6.0 (12 November, 2011)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
456 --------------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
457
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
458 The 0.6.0 release comes with two major changes. Firstly, the index data
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
459 structure has been changed to support genomes longer than 4GB. The forward and
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
460 reverse backward genome is now integrated in one index. This change speeds up
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
461 BWA-short by about 20% and BWA-SW by 90% with the mapping acccuracy largely
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
462 unchanged. A tradeoff is BWA requires more memory, but this is the price almost
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
463 all mappers that index the genome have to pay.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
464
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
465 Secondly, BWA-SW in 0.6.0 now works with paired-end data. It is more accurate
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
466 for highly unique reads and more robust to long indels and structural
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
467 variations. However, BWA-short still has edges for reads with many suboptimal
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
468 hits. It is yet to know which algorithm is the best for variant calling.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
469
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
470 0.5.10 is a bugfix release only and is likely to be the last release in the 0.5
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
471 branch unless I find critical bugs in future.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
472
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
473 Other notable changes:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
474
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
475 * Added the 'fastmap' command that finds super-maximal exact matches. It does
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
476 not give the final alignment, but runs much faster. It can be a building
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
477 block for other alignment algorithms. [0.6.0 only]
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
478
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
479 * Output the timing information before BWA exits. This also tells users that
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
480 the task has been finished instead of being killed or aborted. [0.6.0 only]
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
481
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
482 * Sped up multi-threading when using many (>20) CPU cores.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
483
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
484 * Check I/O error.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
485
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
486 * Increased the maximum barcode length to 63bp.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
487
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
488 * Automatically choose the indexing algorithm.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
489
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
490 * Bugfix: very rare segfault due to an uninitialized variable. The bug also
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
491 affects the placement of suboptimal alignments. The effect is very minor.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
492
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
493 This release involves quite a lot of tricky changes. Although it has been
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
494 tested on a few data sets, subtle bugs may be still hidden. It is *NOT*
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
495 recommended to use this release in a production pipeline. In future, however,
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
496 BWA-SW may be better when reads continue to go longer. I would encourage users
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
497 to try the 0.6 release. I would also like to hear the users' experience. Thank
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
498 you.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
499
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
500 (0.6.0: 12 November 2011, r85)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
501
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
502
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
503
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
504 Beta Release 0.5.9 (24 January, 2011)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
505 -------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
506
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
507 Notable changes:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
508
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
509 * Feature: barcode support via the '-B' option.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
510
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
511 * Feature: Illumina 1.3+ read format support via the '-I' option.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
512
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
513 * Bugfix: RG tags are not attached to unmapped reads.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
514
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
515 * Bugfix: very rare bwasw mismappings
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
516
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
517 * Recommend options for PacBio reads in bwasw help message.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
518
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
519
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
520 Also, since January 13, the BWA master repository has been moved to github:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
521
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
522 https://github.com/lh3/bwa
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
523
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
524 The revision number has been reset. All recent changes will be first
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
525 committed to this repository.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
526
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
527 (0.5.9: 24 January 2011, r16)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
528
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
529
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
530
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
531 Beta Release Candidate 0.5.9rc1 (10 December, 2010)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
532 ---------------------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
533
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
534 Notable changes in bwasw:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
535
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
536 * Output unmapped reads.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
537
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
538 * For a repetitive read, choose a random hit instead of a fixed
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
539 one. This is not well tested.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
540
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
541 Notable changes in bwa-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
542
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
543 * Fixed a bug in the SW scoring system, which may lead to unexpected
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
544 gaps towards the end of a read.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
545
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
546 * Fixed a bug which invalidates the randomness of repetitive reads.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
547
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
548 * Fixed a rare memory leak.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
549
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
550 * Allowed to specify the read group at the command line.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
551
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
552 * Take name-grouped BAM files as input.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
553
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
554 Changes to this release are usually safe in that they do not interfere
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
555 with the key functionality. However, the release has only been tested on
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
556 small samples instead of on large-scale real data. If anything weird
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
557 happens, please report the bugs to the bio-bwa-help mailing list.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
558
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
559 (0.5.9rc1: 10 December 2010, r1561)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
560
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
561
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
562
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
563 Beta Release 0.5.8 (8 June, 2010)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
564 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
565
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
566 Notable changes in bwasw:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
567
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
568 * Fixed an issue of missing alignments. This should happen rarely and
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
569 only when the contig/read alignment is multi-part. Very rarely, bwasw
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
570 may still miss a segment in a multi-part alignment. This is difficult
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
571 to fix, although possible.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
572
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
573 Notable changes in bwa-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
574
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
575 * Discard the SW alignment when the best single-end alignment is much
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
576 better. Such a SW alignment may caused by structural variations and
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
577 forcing it to be aligned leads to false alignment. This fix has not
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
578 been tested thoroughly. It would be great to receive more users
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
579 feedbacks on this issue.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
580
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
581 * Fixed a typo/bug in sampe which leads to unnecessarily large memory
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
582 usage in some cases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
583
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
584 * Further reduced the chance of reporting 'weird pairing'.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
585
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
586 (0.5.8: 8 June 2010, r1442)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
587
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
588
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
589
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
590 Beta Release 0.5.7 (1 March, 2010)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
591 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
592
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
593 This release only has an effect on paired-end data with fat insert-size
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
594 distribution. Users are still recommended to update as the new release
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
595 improves the robustness to poor data.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
596
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
597 * The fix for 'weird pairing' was not working in version 0.5.6, pointed
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
598 out by Carol Scott. It should work now.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
599
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
600 * Optionally output to a normal file rather than to stdout (by Tim
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
601 Fennel).
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
602
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
603 (0.5.7: 1 March 2010, r1310)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
604
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
605
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
606
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
607 Beta Release 0.5.6 (10 Feburary, 2010)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
608 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
609
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
610 Notable changes in bwa-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
611
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
612 * Report multiple hits in the SAM format at a new tag XA encoded as:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
613 (chr,pos,CIGAR,NM;)*. By default, if a paired or single-end read has
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
614 4 or fewer hits, they will all be reported; if a read in a anomalous
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
615 pair has 11 or fewer hits, all of them will be reported.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
616
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
617 * Perform Smith-Waterman alignment also for anomalous read pairs when
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
618 both ends have quality higher than 17. This reduces false positives
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
619 for some SV discovery algorithms.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
620
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
621 * Do not report "weird pairing" when the insert size distribution is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
622 too fat or has a mean close to zero.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
623
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
624 * If a read is bridging two adjacent chromsomes, flag it as unmapped.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
625
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
626 * Fixed a small but long existing memory leak in paired-end mapping.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
627
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
628 * Multiple bug fixes in SOLiD mapping: a) quality "-1" can be correctly
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
629 parsed by solid2fastq.pl; b) truncated quality string is resolved; c)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
630 SOLiD read mapped to the reverse strand is complemented.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
631
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
632 * Bwa now calculates skewness and kurtosis of the insert size
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
633 distribution.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
634
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
635 * Deploy a Bayesian method to estimate the maximum distance for a read
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
636 pair considered to be paired properly. The method is proposed by
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
637 Gerton Lunter, but bwa only implements a simplified version.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
638
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
639 * Export more functions for Java bindings, by Matt Hanna (See:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
640 http://www.broadinstitute.org/gsa/wiki/index.php/Sting_BWA/C_bindings)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
641
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
642 * Abstract bwa CIGAR for further extension, by Rodrigo Goya.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
643
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
644 (0.5.6: 10 Feburary 2010, r1303)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
645
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
646
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
647
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
648 Beta Release 0.5.5 (10 November, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
649 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
650
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
651 This is a bug fix release:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
652
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
653 * Fixed a serious bug/typo in aln which does not occur given short
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
654 reads, but will lead to segfault for >500bp reads. Of course, the aln
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
655 command is not recommended for reads longer than 200bp, but this is a
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
656 bug anyway.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
657
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
658 * Fixed a minor bug/typo which leads to incorrect single-end mapping
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
659 quality when one end is moved to meet the mate-pair requirement.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
660
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
661 * Fixed a bug in samse for mapping in the color space. This bug is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
662 caused by quality filtration added since 0.5.1.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
663
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
664 (0.5.5: 10 November 2009, r1273)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
665
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
666
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
667
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
668 Beta Release 0.5.4 (9 October, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
669 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
670
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
671 Since this version, the default seed length used in the "aln" command is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
672 changed to 32.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
673
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
674 Notable changes in bwa-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
675
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
676 * Added a new tag "XC:i" which gives the length of clipped reads.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
677
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
678 * In sampe, skip alignments in case of a bug in the Smith-Waterman
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
679 alignment module.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
680
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
681 * In sampe, fixed a bug in pairing when the read sequence is identical
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
682 to its reverse complement.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
683
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
684 * In sampe, optionally preload the entire FM-index into memory to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
685 reduce disk operations.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
686
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
687 Notable changes in dBWT-SW/BWA-SW:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
688
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
689 * Changed name dBWT-SW to BWA-SW.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
690
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
691 * Optionally use "hard clipping" in the SAM output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
692
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
693 (0.5.4: 9 October 2009, r1245)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
694
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
695
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
696
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
697 Beta Release 0.5.3 (15 September, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
698 ---------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
699
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
700 Fixed a critical bug in bwa-short: reads mapped to the reverse strand
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
701 are not complemented.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
702
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
703 (0.5.3: 15 September 2009, r1225)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
704
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
705
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
706
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
707 Beta Release 0.5.2 (13 September, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
708 ---------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
709
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
710 Notable changes in bwa-short:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
711
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
712 * Optionally trim reads before alignment. See the manual page on 'aln
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
713 -q' for detailed description.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
714
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
715 * Fixed a bug in calculating the NM tag for a gapped alignment.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
716
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
717 * Fixed a bug given a mixture of reads with some longer than the seed
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
718 length and some shorter.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
719
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
720 * Print SAM header.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
721
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
722 Notable changes in dBWT-SW:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
723
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
724 * Changed the default value of -T to 30. As a result, the accuracy is a
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
725 little higher for short reads at the cost of speed.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
726
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
727 (0.5.2: 13 September 2009, r1223)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
728
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
729
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
730
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
731 Beta Release 0.5.1 (2 September, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
732 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
733
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
734 Notable changes in the short read alignment component:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
735
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
736 * Fixed a bug in samse: do not write mate coordinates.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
737
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
738 Notable changes in dBWT-SW:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
739
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
740 * Randomly choose one alignment if the read is a repetitive.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
741
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
742 * Fixed a flaw when a read is mapped across two adjacent reference
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
743 sequences. However, wrong alignment reports may still occur rarely in
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
744 this case.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
745
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
746 * Changed the default band width to 50. The speed is slower due to this
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
747 change.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
748
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
749 * Improved the mapping quality a little given long query sequences.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
750
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
751 (0.5.1: 2 September 2009, r1209)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
752
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
753
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
754
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
755 Beta Release 0.5.0 (20 August, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
756 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
757
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
758 This release implements a novel algorithm, dBWT-SW, specifically
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
759 designed for long reads. It is 10-50 times faster than SSAHA2, depending
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
760 on the characteristics of the input data, and achieves comparable
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
761 alignment accuracy while allowing chimera detection. In comparison to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
762 BLAT, dBWT-SW is several times faster and much more accurate especially
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
763 when the error rate is high. Please read the manual page for more
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
764 information.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
765
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
766 The dBWT-SW algorithm is kind of developed for future sequencing
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
767 technologies which produce much longer reads with a little higher error
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
768 rate. It is still at its early development stage. Some features are
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
769 missing and it may be buggy although I have evaluated on several
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
770 simulated and real data sets. But following the "release early"
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
771 paradigm, I would like the users to try it first.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
772
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
773 Other notable changes in BWA are:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
774
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
775 * Fixed a rare bug in the Smith-Waterman alignment module.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
776
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
777 * Fixed a rare bug about the wrong alignment coordinate when a read is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
778 poorly aligned.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
779
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
780 * Fixed a bug in generating the "mate-unmap" SAM tag when both ends in
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
781 a pair are unmapped.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
782
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
783 (0.5.0: 20 August 2009, r1200)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
784
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
785
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
786
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
787 Beta Release 0.4.9 (19 May, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
788 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
789
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
790 Interestingly, the integer overflow bug claimed to be fixed in 0.4.7 has
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
791 not in fact. Now I have fixed the bug. Sorry for this and thank Quan
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
792 Long for pointing out the bug (again).
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
793
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
794 (0.4.9: 19 May 2009, r1075)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
795
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
796
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
797
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
798 Beta Release 0.4.8 (18 May, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
799 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
800
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
801 One change to "aln -R". Now by default, if there are no more than '-R'
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
802 equally best hits, bwa will search for suboptimal hits. This change
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
803 affects the ability in finding SNPs in segmental duplications.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
804
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
805 I have not tested this option thoroughly, but this simple change is less
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
806 likely to cause new bugs. Hope I am right.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
807
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
808 (0.4.8: 18 May 2009, r1073)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
809
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
810
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
811
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
812 Beta Release 0.4.7 (12 May, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
813 ---------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
814
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
815 Notable changes:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
816
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
817 * Output SM (single-end mapping quality) and AM (smaller mapping
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
818 quality among the two ends) tag from sam output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
819
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
820 * Improved the functionality of stdsw.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
821
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
822 * Made the XN tag more accurate.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
823
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
824 * Fixed a very rare segfault caused by integer overflow.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
825
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
826 * Improve the insert size estimation.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
827
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
828 * Fixed compiling errors for some Linux systems.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
829
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
830 (0.4.7: 12 May 2009, r1066)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
831
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
832
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
833
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
834 Beta Release 0.4.6 (9 March, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
835 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
836
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
837 This release improves the SOLiD support. First, a script for converting
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
838 SOLiD raw data is provided. This script is adapted from solid2fastq.pl
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
839 in the MAQ package. Second, a nucleotide reference file can be directly
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
840 used with 'bwa index'. Third, SOLiD paired-end support is
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
841 completed. Fourth, color-space reads will be converted to nucleotides
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
842 when SAM output is generated. Color errors are corrected in this
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
843 process. Please note that like MAQ, BWA cannot make use of the primer
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
844 base and the first color.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
845
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
846 In addition, the calculation of mapping quality is also improved a
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
847 little bit, although end-users may barely observe the difference.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
848
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
849 (0.4.6: 9 March 2009, r915)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
850
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
851
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
852
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
853 Beta Release 0.4.5 (18 Feburary, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
854 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
855
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
856 Not much happened, but I think it would be good to let the users use the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
857 latest version.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
858
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
859 Notable changes (Thank Bob Handsaker for catching the two bugs):
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
860
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
861 * Improved bounary check. Previous version may still give incorrect
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
862 alignment coordinates in rare cases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
863
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
864 * Fixed a bug in SW alignment when no residue matches. This only
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
865 affects the 'sampe' command.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
866
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
867 * Robustly estimate insert size without setting the maximum on the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
868 command line. Since this release 'sampe -a' only has an effect if
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
869 there are not enough good pairs to infer the insert size
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
870 distribution.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
871
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
872 * Reduced false PE alignments a little bit by using the inferred insert
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
873 size distribution. This fix may be more important for long insert
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
874 size libraries.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
875
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
876 (0.4.5: 18 Feburary 2009, r829)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
877
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
878
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
879
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
880 Beta Release 0.4.4 (15 Feburary, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
881 --------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
882
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
883 This is mainly a bug fix release. Notable changes are:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
884
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
885 * Imposed boundary check for extracting subsequence from the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
886 genome. Previously this causes memory problem in rare cases.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
887
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
888 * Fixed a bug in failing to find whether an alignment overlapping with
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
889 N on the genome.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
890
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
891 * Changed MD tag to meet the latest SAM specification.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
892
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
893 (0.4.4: 15 Feburary 2009, r815)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
894
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
895
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
896
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
897 Beta Release 0.4.3 (22 January, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
898 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
899
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
900 Notable changes:
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
901
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
902 * Treat an ambiguous base N as a mismatch. Previous versions will not
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
903 map reads containing any N.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
904
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
905 * Automatically choose the maximum allowed number of differences. This
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
906 is important when reads of different lengths are mixed together.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
907
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
908 * Print mate coordinate if only one end is unmapped.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
909
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
910 * Generate MD tag. This tag encodes the mismatching positions and the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
911 reference bases at these positions. Deletions from the reference will
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
912 also be printed.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
913
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
914 * Optionally dump multiple hits from samse, in another concise format
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
915 rather than SAM.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
916
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
917 * Optionally disable iterative search. This is VERY SLOOOOW, though.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
918
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
919 * Fixed a bug in generate SAM.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
920
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
921 (0.4.3: 22 January 2009, r787)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
922
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
923
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
924
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
925 Beta Release 0.4.2 (9 January, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
926 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
927
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
928 Aaron Quinlan found a bug in the indexer: the bwa indexer segfaults if
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
929 there are no comment texts in the FASTA header. This is a critical
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
930 bug. Nothing else was changed.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
931
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
932 (0.4.2: 9 January 2009, r769)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
933
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
934
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
935
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
936 Beta Release 0.4.1 (7 January, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
937 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
938
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
939 I am sorry for the quick updates these days. I like to set a milestone
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
940 for BWA and this release seems to be. For paired end reads, BWA also
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
941 does Smith-Waterman alignment for an unmapped read whose mate can be
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
942 mapped confidently. With this strategy BWA achieves similar accuracy to
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
943 maq. Benchmark is also updated accordingly.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
944
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
945 (0.4.1: 7 January 2009, r760)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
946
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
947
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
948
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
949 Beta Release 0.4.0 (6 January, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
950 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
951
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
952 In comparison to the release two days ago, this release is mainly tuned
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
953 for performance with some tricks I learnt from Bowtie. However, as the
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
954 indexing format has also been changed, I have to increase the version
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
955 number to 0.4.0 to emphasize that *DATABASE MUST BE RE-INDEXED* with
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
956 'bwa index'.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
957
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
958 * Improved the speed by about 20%.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
959
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
960 * Added multi-threading to 'bwa aln'.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
961
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
962 (0.4.0: 6 January 2009, r756)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
963
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
964
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
965
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
966 Beta Release 0.3.0 (4 January, 2009)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
967 ------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
968
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
969 * Added paired-end support by separating SA calculation and alignment
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
970 output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
971
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
972 * Added SAM output.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
973
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
974 * Added evaluation to the documentation.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
975
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
976 (0.3.0: 4 January 2009, r741)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
977
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
978
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
979
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
980 Beta Release 0.2.0 (15 Augusst, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
981 -------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
982
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
983 * Take the subsequence at the 5'-end as seed. Seeding strategy greatly
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
984 improves the speed for long reads, at the cost of missing a few true
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
985 hits that contain many differences in the seed. Seeding also increase
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
986 the memory by 800MB.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
987
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
988 * Fixed a bug which may miss some gapped alignments. Fixing the bug
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
989 also slows the speed a little.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
990
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
991 (0.2.0: 15 August 2008, r428)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
992
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
993
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
994
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
995 Beta Release 0.1.6 (08 Augusst, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
996 -------------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
997
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
998 * Give accurate CIGAR string.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
999
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1000 * Add a simple interface to SW/NW alignment
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1001
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1002 (0.1.6: 08 August 2008, r414)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1003
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1004
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1005
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1006 Beta Release 0.1.5 (27 July, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1007 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1008
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1009 * Improve the speed. This version is expected to give the same results.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1010
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1011 (0.1.5: 27 July 2008, r400)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1012
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1013
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1014
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1015 Beta Release 0.1.4 (22 July, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1016 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1017
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1018 * Fixed a bug which may cause missing gapped alignments.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1019
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1020 * More clearly define what alignments can be found by BWA (See
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1021 manual). Now BWA runs a little slower because it will visit more
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1022 potential gapped alignments.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1023
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1024 * A bit code clean up.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1025
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1026 (0.1.4: 22 July 2008, r387)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1027
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1028
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1029
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1030 Beta Release 0.1.3 (21 July, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1031 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1032
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1033 Improve the speed with some tricks on retrieving occurences. The results
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1034 should be exactly the same as that of 0.1.2.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1035
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1036 (0.1.3: 21 July 2008, r382)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1037
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1038
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1039
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1040 Beta Release 0.1.2 (17 July, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1041 ----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1042
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1043 Support gapped alignment. Codes for ungapped alignment has been removed.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1044
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1045 (0.1.2: 17 July 2008, r371)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1046
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1047
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1048
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1049 Beta Release 0.1.1 (03 June, 2008)
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1050 -----------------------------------
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1051
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1052 This is the first release of BWA, Burrows-Wheeler Alignment tool. Please
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1053 read man page for more information about this software.
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1054
ce5a8082bbb8 Uploaded
xilinxu
parents:
diff changeset
1055 (0.1.1: 03 June 2008, r349)