1 Beta Release 0.1.9 (27 October, 2010)
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4 This release is featured as the first major improvement to the samtools'
5 SNP caller. It comes with a revised MAQ error model, the support of
6 multi-sample SNP calling and the computation of base alignment quality
9 The revised MAQ error model is based on the original model. It solves an
10 issue of miscalling SNPs in repetitive regions. Althought such SNPs can
11 usually be filtered at a later step, they mess up unfiltered calls. This
12 is a theoretical flaw in the original model. The revised MAQ model
13 deprecates the orginal MAQ model and the simplified SOAPsnp model.
15 Multi-sample SNP calling is separated in two steps. The first is done by
16 samtools mpileup and the second by a new program, bcftools, which is
17 included in the samtools source code tree. Multi-sample SNP calling also
18 works for single sample and has the advantage of enabling more powerful
19 filtration. It is likely to deprecate pileup in future once a proper
20 indel calling method is implemented.
22 BAQ is the Phred-scaled probability of a read base being wrongly
23 aligned. Capping base quality by BAQ has been shown to be very effective
24 in suppressing false SNPs caused by misalignments around indels or in
25 low-complexity regions with acceptable compromise on computation
26 time. This strategy is highly recommended and can be used with other SNP
29 In addition to the three major improvements, other notable changes are:
31 * Changes to the pileup format. A reference skip (the N CIGAR operator)
32 is shown as '<' or '>' depending on the strand. Tview is also changed
35 * Accelerated pileup. The plain pileup is about 50% faster.
37 * Regional merge. The merge command now accepts a new option to merge
38 files in a specified region.
40 * Fixed a bug in bgzip and razip which causes source files to be
41 deleted even if option -c is applied.
43 * In APIs, propogate errors to downstream callers and make samtools
44 return non-zero values once errors occur.
46 (0.1.9: 27 October 2010, r783)
50 Beta Release 0.1.8 (11 July, 2010)
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 Notable functional changes:
55 * Added the `reheader' command which replaces a BAM header with a new
56 header. This command is much faster than replacing header by
57 BAM->SAM->BAM conversions.
59 * Added the `mpileup' command which computes the pileup of multiple
62 * The `index' command now stores the number of mapped and unmapped
63 reads in the index file. This information can be retrieved quickly by
64 the new `idxstats' command.
66 * By default, pileup used the SOAPsnp model for SNP calling. This
67 avoids the floating overflow in the MAQ model which leads to spurious
68 calls in repetitive regions, although these calls will be immediately
69 filtered by varFilter.
71 * The `tview' command now correctly handles CIGARs like 7I10M and
72 10M1P1I10M which cause assertion failure in earlier versions.
74 * Tview accepts a region like `=10,000' where `=' stands for the
75 current sequence name. This saves typing for long sequence names.
77 * Added the `-d' option to `pileup' which avoids slow indel calling
78 in ultradeep regions by subsampling reads locally.
80 * Added the `-R' option to `view' which retrieves alignments in read
81 groups listed in the specified file.
83 Performance improvements:
85 * The BAM->SAM conversion is up to twice faster, depending on the
86 characteristic of the input.
88 * Parsing SAM headers with a lot of reference sequences is now much
91 * The number of lseek() calls per query is reduced when the query
92 region contains no read alignments.
96 * Fixed an issue in the indel caller that leads to miscall of indels.
97 Note that this solution may not work well when the sequencing indel
98 error rate is higher than the rate of SNPs.
100 * Fixed another issue in the indel caller which may lead to incorrect
103 * Fixed a bug in `sort' when option `-o' is applied.
105 * Fixed a bug in `view -r'.
107 APIs and other changes:
109 * Added iterator interfaces to random access and pileup. The callback
110 interfaces directly call the iterator interfaces.
112 * The BGZF blocks holding the BAM header are indepedent of alignment
113 BGZF blocks. Alignment records shorter than 64kB is guaranteed to be
114 fully contained in one BGZF block. This change is fully compatible
115 with the old version of samtools/picard.
117 Changes in other utilities:
119 * Updated export2sam.pl by Chris Saunders.
121 * Improved the sam2vcf.pl script.
123 * Added a Python version of varfilter.py by Aylwyn Scally.
125 (0.1.8: 11 July 2010, r613)
129 Beta Release 0.1.7 (10 November, 2009)
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 * Improved the indel caller in complex scenariors, in particular for
135 long reads. The indel caller is now able to make reasonable indel
136 calls from Craig Venter capillary reads.
138 * Rewrote single-end duplicate removal with improved
139 performance. Paired-end reads are not touched.
141 * Duplicate removal is now library aware. Samtools remove potential
142 PCR/optical dupliates inside a library rather than across libraries.
144 * SAM header is now fully parsed, although this functionality is not
145 used in merging and so on.
147 * In samtools merge, optionally take the input file name as RG-ID and
148 attach the RG tag to each alignment.
150 * Added FTP support in the RAZF library. RAZF-compressed reference
151 sequence can be retrieved remotely.
153 * Improved network support for Win32.
155 * Samtools sort and merge are now stable.
157 Changes in other utilities:
159 * Implemented sam2vcf.pl that converts the pileup format to the VCF
162 * This release of samtools is known to work with the latest
163 Bio-Samtools Perl module.
165 (0.1.7: 10 November 2009, r510)
169 Beta Release 0.1.6 (2 September, 2009)
170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174 * In tview, do not show a blank screen when no reads mapped to the
175 corresponding region.
177 * Implemented native HTTP support in the BGZF library. Samtools is now
178 able to directly open a BAM file on HTTP. HTTP proxy is also
179 supported via the "http_proxy" environmental variable.
181 * Samtools is now compitable with the MinGW (win32) compiler and the
184 * The calmd (or fillmd) command now calculates the NM tag and replaces
185 MD tags if they are wrong.
187 * The view command now recognizes and optionally prints FLAG in HEXs or
188 strings to make a SAM file more friendly to human eyes. This is a
189 samtools-C extension, not implemented in Picard for the time
190 being. Please type `samtools view -?' for more information.
192 * BAM files now have an end-of-file (EOF) marker to facilitate
193 truncation detection. A warning will be given if an on-disk BAM file
194 does not have this marker. The warning will be seen on BAM files
195 generated by an older version of samtools. It does NO harm.
197 * New key bindings in tview: `r' to show read names and `s' to show
198 reference skip (N operation) as deletions.
200 * Fixed a bug in `samtools merge -n'.
202 * Samtools merge now optionally copies the header of a user specified
203 SAM file to the resultant BAM output.
205 * Samtools pileup/tview works with a CIGAR with the first or the last
206 operation is an indel.
208 * Fixed a bug in bam_aux_get().
211 Changes in other utilies:
213 * Fixed wrong FLAG in maq2sam.
216 (0.1.6: 2 September 2009, r453)
220 Beta Release 0.1.5 (7 July, 2009)
221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 * Support opening a BAM alignment on FTP. Users can now use "tview" to
226 view alignments at the NCBI ftp site. Please read manual for more
229 * In library, propagate errors rather than exit or complain assertion
232 * Simplified the building system and fixed compiling errors caused by
235 * Fixed an issue about lost header information when a SAM is imported
238 * Implemented "samtool.pl varFilter" which filters both SNPs and short
239 indels. This command replaces "indelFilter".
241 * Implemented "samtools.pl pileup2fq" to generate FASTQ consensus from
244 * In pileup, cap mapping quality at 60. This helps filtering when
245 different aligners are in use.
247 * In pileup, allow to output variant sites only.
249 * Made pileup generate correct calls in repetitive region. At the same
250 time, I am considering to implement a simplified model in SOAPsnp,
251 although this has not happened yet.
253 * In view, added '-u' option to output BAM without compression. This
254 option is preferred when the output is piped to other commands.
256 * In view, added '-l' and '-r' to get the alignments for one library or
257 read group. The "@RG" header lines are now partially parsed.
259 * Do not include command line utilities to libbam.a.
261 * Fixed memory leaks in pileup and bam_view1().
263 * Made faidx more tolerant to empty lines right before or after FASTA >
267 Changes in other utilities:
269 * Updated novo2sam.pl by Colin Hercus, the key developer of novoalign.
272 This release involves several modifications to the key code base which
273 may potentially introduce new bugs even though we have tried to minimize
274 this by testing on several examples. Please let us know if you catch
277 (0.1.5: 7 July 2009, r373)
281 Beta Release 0.1.4 (21 May, 2009)
282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
286 * Added the 'rmdupse' command: removing duplicates for SE reads.
288 * Fixed a critical bug in the indel caller: clipped alignments are not
291 * Fixed a bug in the tview: gapped alignment may be incorrectly
294 * Unified the interface to BAM and SAM I/O. This is done by
295 implementing a wrapper on top of the old APIs and therefore old APIs
296 are still valid. The new I/O APIs also recognize the @SQ header
299 * Generate the MD tag.
301 * Generate "=" bases. However, the indel caller will not work when "="
304 * Enhanced support of color-read display (by Nils Homer).
306 * Implemented the GNU building system. However, currently the building
307 system does not generate libbam.a. We will improve this later. For
308 the time being, `make -f Makefile.generic' is preferred.
310 * Fixed a minor bug in pileup: the first read in a chromosome may be
313 * Fixed bugs in bam_aux.c. These bugs do not affect other components as
314 they were not used previously.
316 * Output the 'SM' tag from maq2sam.
318 (0.1.4: 21 May 2009, r297)
322 Beta Release 0.1.3 (15 April, 2009)
323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
325 Notable changes in SAMtools:
327 * SAMtools is more consistent with the specification: a) '*' in the
328 QUAL field is allowed; b) the field separator is TAB only and SPACE
329 is treated as a character in a field; c) empty header is allowed.
331 * Implemented GLFv3 support in pileup.
333 * Fixed a severe bug in fixmate: strand information is wrongly
336 * Fixed a bug in alignment retrieval: alignments bridging n*16384bp are
337 not correctly retrieved sometimes.
339 * Fixed a bug in rmdup: segfault if unmapped reads are present.
341 * Move indel_filter.pl to samtools.pl and improved the filtering by
342 checking the actual number of alignments containing indels. The indel
343 pileup line is also changed a little to make this filtration easier.
345 * Fixed a minor bug in indexing: the bin number of an unmapped read is
348 * Added `flagstat' command to show statistics on the FLAG field.
350 * Improved indel caller by setting the maximum window size in local
353 Changes in other utilities:
355 * Fixed a bug in maq2sam: a tag name is obsolete.
357 * Improvement to wgsim: a) added support for SOLiD read simulation; b)
358 show the number of substitutions/indels/errors in read name; c)
359 considerable code clean up.
361 * Various converters: improved functionality in general.
363 * Updated the example SAM due to the previous bug in fixmate.
365 (0.1.3: 15 April 2009, r227)
369 Beta Release 0.1.2 (28 January, 2008)
370 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
372 Notable changes in SAMtools:
374 * Implemented a Bayesian indel caller. The new caller generate scores
375 and genotype and is potentially more accurate than Maq's indel
376 caller. The pileup format is also changed accordingly.
378 * Implemented rmdup command: remove potential PCR duplicates. Note that
379 this command ONLY works for FR orientation and requires ISIZE is
382 * Added fixmate command: fill in mate coordinates, ISIZE and mate
383 related flags from a name-sorted alignment.
385 * Fixed a bug in indexing: reads bridging 16x kbp were not retrieved.
387 * Allow to select reads shown in the pileup output with a mask.
389 * Generate GLFv2 from pileup.
391 * Added two more flags for flagging PCR/optical duplicates and for QC
394 * Fixed a bug in sort command: name sorting for large alignment did not
397 * Allow to completely disable RAZF (using Makefile.lite) as some people
398 have problem to compile it.
400 * Fixed a bug in import command when there are reads without
403 * Fixed a bug in tview: clipping broke the alignment viewer.
405 * Fixed a compiling error when _NO_CURSES is applied.
407 * Fixed a bug in merge command.
409 Changes in other utilities:
411 * Added wgsim, a paired-end reads simulator. Wgsim was adapted from
412 maq's reads simulator. Colin Hercus further improved it to allow
415 * Added wgsim_eval.pl, a script that evaluates the accuracy of
416 alignment on reads generated by wgsim.
418 * Added soap2sam.pl, a SOAP2->SAM converter. This converter does not
419 work properly when multiple hits are output.
421 * Added bowtie2sam.pl, a Bowtie->SAM converter. Only the top hit will
422 be retained when multiple hits are present.
424 * Fixed a bug in export2sam.pl for QC reads.
426 * Support RG tag at MAQ->SAM converter.
428 * Added novo2sam.pl, a NovoAlign->SAM converter. Multiple hits and
429 indel are not properly handled, though.
431 * Added zoom2sam.pl, a ZOOM->SAM converter. It only works with the
432 default Illumina output.
434 (0.1.2: 28 January 2008; r116)
438 Beta Release 0.1.1 (22 December, 2008)
439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
441 The is the first public release of samtools. For more information,
442 please check the manual page `samtools.1' and the samtools website
443 http://samtools.sourceforge.net