Imported Upstream version 0.1.7a~dfsg
[samtools.git] / NEWS
1 Beta Release 0.1.7 (10 November, 2009)
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4 Notable changes:
5
6  * Improved the indel caller in complex scenariors, in particular for
7    long reads. The indel caller is now able to make reasonable indel
8    calls from Craig Venter capillary reads.
9
10  * Rewrote single-end duplicate removal with improved
11    performance. Paired-end reads are not touched.
12
13  * Duplicate removal is now library aware. Samtools remove potential
14    PCR/optical dupliates inside a library rather than across libraries.
15
16  * SAM header is now fully parsed, although this functionality is not
17    used in merging and so on.
18
19  * In samtools merge, optionally take the input file name as RG-ID and
20    attach the RG tag to each alignment.
21
22  * Added FTP support in the RAZF library. RAZF-compressed reference
23    sequence can be retrieved remotely.
24
25  * Improved network support for Win32.
26
27  * Samtools sort and merge are now stable.
28
29 Changes in other utilities:
30
31  * Implemented sam2vcf.pl that converts the pileup format to the VCF
32    format.
33
34  * This release of samtools is known to work with the latest
35    Bio-Samtools Perl module.
36
37 (0.1.7: 10 November 2009, r510)
38
39
40
41 Beta Release 0.1.6 (2 September, 2009)
42 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
44 Notable changes:
45
46  * In tview, do not show a blank screen when no reads mapped to the
47    corresponding region.
48
49  * Implemented native HTTP support in the BGZF library. Samtools is now
50    able to directly open a BAM file on HTTP. HTTP proxy is also
51    supported via the "http_proxy" environmental variable.
52
53  * Samtools is now compitable with the MinGW (win32) compiler and the
54    PDCurses library.
55
56  * The calmd (or fillmd) command now calculates the NM tag and replaces
57    MD tags if they are wrong.
58
59  * The view command now recognizes and optionally prints FLAG in HEXs or
60    strings to make a SAM file more friendly to human eyes. This is a
61    samtools-C extension, not implemented in Picard for the time
62    being. Please type `samtools view -?' for more information.
63
64  * BAM files now have an end-of-file (EOF) marker to facilitate
65    truncation detection. A warning will be given if an on-disk BAM file
66    does not have this marker. The warning will be seen on BAM files
67    generated by an older version of samtools. It does NO harm.
68
69  * New key bindings in tview: `r' to show read names and `s' to show
70    reference skip (N operation) as deletions.
71
72  * Fixed a bug in `samtools merge -n'.
73
74  * Samtools merge now optionally copies the header of a user specified
75    SAM file to the resultant BAM output.
76
77  * Samtools pileup/tview works with a CIGAR with the first or the last
78    operation is an indel.
79
80  * Fixed a bug in bam_aux_get().
81
82
83 Changes in other utilies:
84
85  * Fixed wrong FLAG in maq2sam.
86
87
88 (0.1.6: 2 September 2009, r453)
89
90
91
92 Beta Release 0.1.5 (7 July, 2009)
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
95 Notable changes:
96
97  * Support opening a BAM alignment on FTP. Users can now use "tview" to
98    view alignments at the NCBI ftp site. Please read manual for more
99    information.
100
101  * In library, propagate errors rather than exit or complain assertion
102    failure.
103
104  * Simplified the building system and fixed compiling errors caused by
105    zlib<1.2.2.1.
106
107  * Fixed an issue about lost header information when a SAM is imported
108    with "view -t".
109
110  * Implemented "samtool.pl varFilter" which filters both SNPs and short
111    indels. This command replaces "indelFilter".
112
113  * Implemented "samtools.pl pileup2fq" to generate FASTQ consensus from
114    pileup output.
115
116  * In pileup, cap mapping quality at 60. This helps filtering when
117    different aligners are in use.
118
119  * In pileup, allow to output variant sites only.
120
121  * Made pileup generate correct calls in repetitive region. At the same
122    time, I am considering to implement a simplified model in SOAPsnp,
123    although this has not happened yet.
124
125  * In view, added '-u' option to output BAM without compression. This
126    option is preferred when the output is piped to other commands.
127
128  * In view, added '-l' and '-r' to get the alignments for one library or
129    read group. The "@RG" header lines are now partially parsed.
130
131  * Do not include command line utilities to libbam.a.
132
133  * Fixed memory leaks in pileup and bam_view1().
134
135  * Made faidx more tolerant to empty lines right before or after FASTA >
136    lines.
137
138
139 Changes in other utilities:
140
141  * Updated novo2sam.pl by Colin Hercus, the key developer of novoalign.
142
143
144 This release involves several modifications to the key code base which
145 may potentially introduce new bugs even though we have tried to minimize
146 this by testing on several examples. Please let us know if you catch
147 bugs.
148
149 (0.1.5: 7 July 2009, r373)
150
151
152
153 Beta Release 0.1.4 (21 May, 2009)
154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155
156 Notable changes:
157
158  * Added the 'rmdupse' command: removing duplicates for SE reads.
159
160  * Fixed a critical bug in the indel caller: clipped alignments are not
161    processed correctly.
162
163  * Fixed a bug in the tview: gapped alignment may be incorrectly
164    displayed.
165
166  * Unified the interface to BAM and SAM I/O. This is done by
167    implementing a wrapper on top of the old APIs and therefore old APIs
168    are still valid. The new I/O APIs also recognize the @SQ header
169    lines.
170
171  * Generate the MD tag.
172
173  * Generate "=" bases. However, the indel caller will not work when "="
174    bases are present.
175
176  * Enhanced support of color-read display (by Nils Homer).
177
178  * Implemented the GNU building system. However, currently the building
179    system does not generate libbam.a. We will improve this later. For
180    the time being, `make -f Makefile.generic' is preferred.
181
182  * Fixed a minor bug in pileup: the first read in a chromosome may be
183    skipped.
184
185  * Fixed bugs in bam_aux.c. These bugs do not affect other components as
186    they were not used previously.
187
188  * Output the 'SM' tag from maq2sam.
189
190 (0.1.4: 21 May 2009, r297)
191
192
193
194 Beta Release 0.1.3 (15 April, 2009)
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196
197 Notable changes in SAMtools:
198
199  * SAMtools is more consistent with the specification: a) '*' in the
200    QUAL field is allowed; b) the field separator is TAB only and SPACE
201    is treated as a character in a field; c) empty header is allowed.
202
203  * Implemented GLFv3 support in pileup.
204
205  * Fixed a severe bug in fixmate: strand information is wrongly
206    overwritten.
207
208  * Fixed a bug in alignment retrieval: alignments bridging n*16384bp are
209    not correctly retrieved sometimes.
210
211  * Fixed a bug in rmdup: segfault if unmapped reads are present.
212
213  * Move indel_filter.pl to samtools.pl and improved the filtering by
214    checking the actual number of alignments containing indels. The indel
215    pileup line is also changed a little to make this filtration easier.
216
217  * Fixed a minor bug in indexing: the bin number of an unmapped read is
218    wrongly calculated.
219
220  * Added `flagstat' command to show statistics on the FLAG field.
221
222  * Improved indel caller by setting the maximum window size in local
223    realignment.
224
225 Changes in other utilities:
226
227  * Fixed a bug in maq2sam: a tag name is obsolete.
228
229  * Improvement to wgsim: a) added support for SOLiD read simulation; b)
230    show the number of substitutions/indels/errors in read name; c)
231    considerable code clean up.
232
233  * Various converters: improved functionality in general.
234
235  * Updated the example SAM due to the previous bug in fixmate.
236
237 (0.1.3: 15 April 2009, r227)
238
239
240
241 Beta Release 0.1.2 (28 January, 2008)
242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
243
244 Notable changes in SAMtools:
245
246  * Implemented a Bayesian indel caller. The new caller generate scores
247    and genotype and is potentially more accurate than Maq's indel
248    caller. The pileup format is also changed accordingly.
249
250  * Implemented rmdup command: remove potential PCR duplicates. Note that
251    this command ONLY works for FR orientation and requires ISIZE is
252    correctly set.
253
254  * Added fixmate command: fill in mate coordinates, ISIZE and mate
255    related flags from a name-sorted alignment.
256
257  * Fixed a bug in indexing: reads bridging 16x kbp were not retrieved.
258
259  * Allow to select reads shown in the pileup output with a mask.
260
261  * Generate GLFv2 from pileup.
262
263  * Added two more flags for flagging PCR/optical duplicates and for QC
264    failure.
265
266  * Fixed a bug in sort command: name sorting for large alignment did not
267    work.
268
269  * Allow to completely disable RAZF (using Makefile.lite) as some people
270    have problem to compile it.
271
272  * Fixed a bug in import command when there are reads without
273    coordinates.
274
275  * Fixed a bug in tview: clipping broke the alignment viewer.
276
277  * Fixed a compiling error when _NO_CURSES is applied.
278
279  * Fixed a bug in merge command.
280
281 Changes in other utilities:
282
283  * Added wgsim, a paired-end reads simulator. Wgsim was adapted from
284    maq's reads simulator. Colin Hercus further improved it to allow
285    longer indels.
286
287  * Added wgsim_eval.pl, a script that evaluates the accuracy of
288    alignment on reads generated by wgsim.
289
290  * Added soap2sam.pl, a SOAP2->SAM converter. This converter does not
291    work properly when multiple hits are output.
292
293  * Added bowtie2sam.pl, a Bowtie->SAM converter. Only the top hit will
294    be retained when multiple hits are present.
295
296  * Fixed a bug in export2sam.pl for QC reads.
297
298  * Support RG tag at MAQ->SAM converter.
299
300  * Added novo2sam.pl, a NovoAlign->SAM converter. Multiple hits and
301    indel are not properly handled, though.
302
303  * Added zoom2sam.pl, a ZOOM->SAM converter. It only works with the
304    default Illumina output.
305
306 (0.1.2: 28 January 2008; r116)
307
308
309
310 Beta Release 0.1.1 (22 December, 2008)
311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
312
313 The is the first public release of samtools. For more information,
314 please check the manual page `samtools.1' and the samtools website
315 http://samtools.sourceforge.net