1 Beta release 0.1.13 (28 February, 2011)
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4 The most important though largely invisible modification is the change of the
5 order of genotypes in the PL VCF/BCF tag. This is to conform the upcoming VCF
6 spec v4.1. The change means that 0.1.13 is not backward compatible with VCF/BCF
7 generated by samtools older than r921 inclusive. VCF/BCF generated by the new
8 samtools will contain a line `##fileformat=VCFv4.1' as well as the samtools
11 Single Individual Haplotyping (SIH) is added as an experimental feature. It
12 originally aims to produce haploid consensus from fosmid pool sequencing, but
13 also works with short-read data. For short reads, phased blocks are usually too
14 short to be useful in most applications, but phasing can be powerful for ruling
15 out some SNPs close to INDELs and some of clustered spurious SNPs between copies
16 of CNVs. On one data set, phasing based SNP calling is better in terms of both
17 sensitivity and specificity than the standard methods.
20 Other notable changes in samtools:
22 * Construct per-sample consensus to reduced the effect of nearby SNPs in INDEL
23 calling. This may reduce the power, but improves specificity.
25 * Improved sorting order checking in indexing. Now indexing is the preferred way
26 to check if a BAM is sorted.
28 * Added a switch `-E' to mpileup and calmd. This option uses an alternative way
29 to apply BAQ, which increases sensistivity, especially to MNPs, at the cost of
30 a little loss in specificity.
32 * Added `mpileup -A' to allow to use reads in anomalous pairs in SNP calling.
34 * Added `mpileup -m' to allow fine control of INDEL candidates.
36 * Added `mpileup -S' to compute per-sample strand bias P-value.
38 * Added `mpileup -G' to exclude read groups in variant calling.
40 * Fixed segfault in indel calling related to unmapped and refskip reads.
42 * Fixed an integer overflow in INDEL calling. This bug produces wrong INDEL
43 genotypes for longer INDELs, typically over 10bp.
45 * Fixed a bug in tview on big-endian machines.
47 * Fixed a very rare memory issue in bam_md.c
49 * Fixed an out-of-boundary bug in mpileup when the read base is `N'.
51 * Fixed a compiling error when the knetfile library is not used. Fixed a
52 library compiling error due to the lack of bam_nt16_nt4_table[] table.
55 Other notable changes in bcftools:
57 * Updated the BCF spec.
59 * Added the `FQ' VCF INFO field, which gives the phred-scaled probability
60 of all samples being the samei (identical to the reference or all homozygous
61 variants). Option `view -f' has been dropped.
63 * Implementated of "vcfutils.pl vcf2fq" to generate a consensus sequence
64 similar to "samtools.pl pileup2fq".
66 * Make sure the GT FORMAT field is always the first FORMAT to conform the VCF
67 spec. Drop bcf-fix.pl.
69 * Output bcftools specific INFO and FORMAT in the VCF header.
71 * Added `view -s' to call variants from a subset of samples.
73 * Properly convert VCF to BCF with a user provided sequence dictionary. Nonetheless,
74 custom fields are still unparsed and will be stored as a missing value.
76 * Fixed a minor bug in Fisher's exact test; the results are rarely changed.
79 (0.1.13: 28 February 2011, r926+130)
83 Beta release 0.1.12a (2 December, 2010)
84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86 This is another bug fix release:
88 * Fixed a memory violation in mpileup, which causes segfault. Release
89 0.1.9 and above are affected.
91 * Fixed a memory violation in the indel caller, which does not causes
92 segfault, but may potentially affect deletion calls in an unexpected
93 way. Release 0.1.10 and above are affected.
95 * Fixed a bug in computing r-square in bcftools. Few are using this
96 functionality and it only has minor effect.
98 * Fixed a memory leak in bam_fetch().
100 * Fixed a bug in writing meta information to the BAM index for the last
101 sequence. This bug is invisible to most users, but it is a bug anyway.
103 * Fixed a bug in bcftools which causes false "DP4=0,0,0,0" annotations.
105 (0.1.12: 2 December 2010, r862)
109 Beta release 0.1.11 (21 November, 2010)
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 This is mainly a bug fix release:
114 * Fixed a bug in random retrieval (since 0.1.8). It occurs when reads
115 are retrieved from a small region containing no reads.
117 * Fixed a bug in pileup (since 0.1.9). The bug causes an assertion
118 failure when the first CIGAR operation is a deletion.
120 * Improved fault tolerence in remote access.
122 One minor feature has been implemented in bcftools:
124 * Added a reference-free variant calling mode. In this mode, a site is
125 regarded as a variat iff the sample(s) contains two or more alleles;
126 the meaning of the QUAL field in the VCF output is changed
127 accordingly. Effectively, the reference allele is irrelevant to the
128 result in the new mode, although the reference sequence has to be
129 used in realignment when SAMtools computes genotype likelihoods.
131 In addition, since 0.1.10, the `pileup' command has been deprecated by
132 `mpileup' which is more powerful and more accurate. The `pileup' command
133 will not be removed in the next few releases, but new features will not
136 (0.1.11: 21 November 2010, r851)
140 Beta Release 0.1.10 (16 November, 2010)
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143 This release is featured as the first major improvement to the indel
144 caller. The method is similar to the old one implemented in the pileup
145 command, but the details are handled more carefully both in theory and
146 in practice. As a result, the new indel caller usually gives more
147 accurate indel calls, though at the cost of sensitivity. The caller is
148 implemented in the mpileup command and is invoked by default. It works
149 with multiple samples.
151 Other notable changes:
153 * With the -r option, the calmd command writes the difference between
154 the original base quality and the BAQ capped base quality at the BQ
155 tag but does not modify the base quality. Please use -Ar to overwrite
156 the original base quality (the 0.1.9 behavior).
158 * Allow to set a maximum per-sample read depth to reduce memory. In
159 0.1.9, most of memory is wasted for the ultra high read depth in some
160 regions (e.g. the chr1 centromere).
162 * Optionally write per-sample read depth and per-sample strand bias
165 * Compute equal-tail (Bayesian) credible interval of site allele
166 frequency at the CI95 VCF annotation.
168 * Merged the vcfutils.pl varFilter and filter4vcf for better SNP/indel
171 (0.1.10: 16 November 2010, r829)
175 Beta Release 0.1.9 (27 October, 2010)
176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
178 This release is featured as the first major improvement to the samtools'
179 SNP caller. It comes with a revised MAQ error model, the support of
180 multi-sample SNP calling and the computation of base alignment quality
183 The revised MAQ error model is based on the original model. It solves an
184 issue of miscalling SNPs in repetitive regions. Althought such SNPs can
185 usually be filtered at a later step, they mess up unfiltered calls. This
186 is a theoretical flaw in the original model. The revised MAQ model
187 deprecates the orginal MAQ model and the simplified SOAPsnp model.
189 Multi-sample SNP calling is separated in two steps. The first is done by
190 samtools mpileup and the second by a new program, bcftools, which is
191 included in the samtools source code tree. Multi-sample SNP calling also
192 works for single sample and has the advantage of enabling more powerful
193 filtration. It is likely to deprecate pileup in future once a proper
194 indel calling method is implemented.
196 BAQ is the Phred-scaled probability of a read base being wrongly
197 aligned. Capping base quality by BAQ has been shown to be very effective
198 in suppressing false SNPs caused by misalignments around indels or in
199 low-complexity regions with acceptable compromise on computation
200 time. This strategy is highly recommended and can be used with other SNP
203 In addition to the three major improvements, other notable changes are:
205 * Changes to the pileup format. A reference skip (the N CIGAR operator)
206 is shown as '<' or '>' depending on the strand. Tview is also changed
209 * Accelerated pileup. The plain pileup is about 50% faster.
211 * Regional merge. The merge command now accepts a new option to merge
212 files in a specified region.
214 * Fixed a bug in bgzip and razip which causes source files to be
215 deleted even if option -c is applied.
217 * In APIs, propogate errors to downstream callers and make samtools
218 return non-zero values once errors occur.
220 (0.1.9: 27 October 2010, r783)
224 Beta Release 0.1.8 (11 July, 2010)
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 Notable functional changes:
229 * Added the `reheader' command which replaces a BAM header with a new
230 header. This command is much faster than replacing header by
231 BAM->SAM->BAM conversions.
233 * Added the `mpileup' command which computes the pileup of multiple
236 * The `index' command now stores the number of mapped and unmapped
237 reads in the index file. This information can be retrieved quickly by
238 the new `idxstats' command.
240 * By default, pileup used the SOAPsnp model for SNP calling. This
241 avoids the floating overflow in the MAQ model which leads to spurious
242 calls in repetitive regions, although these calls will be immediately
243 filtered by varFilter.
245 * The `tview' command now correctly handles CIGARs like 7I10M and
246 10M1P1I10M which cause assertion failure in earlier versions.
248 * Tview accepts a region like `=10,000' where `=' stands for the
249 current sequence name. This saves typing for long sequence names.
251 * Added the `-d' option to `pileup' which avoids slow indel calling
252 in ultradeep regions by subsampling reads locally.
254 * Added the `-R' option to `view' which retrieves alignments in read
255 groups listed in the specified file.
257 Performance improvements:
259 * The BAM->SAM conversion is up to twice faster, depending on the
260 characteristic of the input.
262 * Parsing SAM headers with a lot of reference sequences is now much
265 * The number of lseek() calls per query is reduced when the query
266 region contains no read alignments.
270 * Fixed an issue in the indel caller that leads to miscall of indels.
271 Note that this solution may not work well when the sequencing indel
272 error rate is higher than the rate of SNPs.
274 * Fixed another issue in the indel caller which may lead to incorrect
277 * Fixed a bug in `sort' when option `-o' is applied.
279 * Fixed a bug in `view -r'.
281 APIs and other changes:
283 * Added iterator interfaces to random access and pileup. The callback
284 interfaces directly call the iterator interfaces.
286 * The BGZF blocks holding the BAM header are indepedent of alignment
287 BGZF blocks. Alignment records shorter than 64kB is guaranteed to be
288 fully contained in one BGZF block. This change is fully compatible
289 with the old version of samtools/picard.
291 Changes in other utilities:
293 * Updated export2sam.pl by Chris Saunders.
295 * Improved the sam2vcf.pl script.
297 * Added a Python version of varfilter.py by Aylwyn Scally.
299 (0.1.8: 11 July 2010, r613)
303 Beta Release 0.1.7 (10 November, 2009)
304 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308 * Improved the indel caller in complex scenariors, in particular for
309 long reads. The indel caller is now able to make reasonable indel
310 calls from Craig Venter capillary reads.
312 * Rewrote single-end duplicate removal with improved
313 performance. Paired-end reads are not touched.
315 * Duplicate removal is now library aware. Samtools remove potential
316 PCR/optical dupliates inside a library rather than across libraries.
318 * SAM header is now fully parsed, although this functionality is not
319 used in merging and so on.
321 * In samtools merge, optionally take the input file name as RG-ID and
322 attach the RG tag to each alignment.
324 * Added FTP support in the RAZF library. RAZF-compressed reference
325 sequence can be retrieved remotely.
327 * Improved network support for Win32.
329 * Samtools sort and merge are now stable.
331 Changes in other utilities:
333 * Implemented sam2vcf.pl that converts the pileup format to the VCF
336 * This release of samtools is known to work with the latest
337 Bio-Samtools Perl module.
339 (0.1.7: 10 November 2009, r510)
343 Beta Release 0.1.6 (2 September, 2009)
344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
348 * In tview, do not show a blank screen when no reads mapped to the
349 corresponding region.
351 * Implemented native HTTP support in the BGZF library. Samtools is now
352 able to directly open a BAM file on HTTP. HTTP proxy is also
353 supported via the "http_proxy" environmental variable.
355 * Samtools is now compitable with the MinGW (win32) compiler and the
358 * The calmd (or fillmd) command now calculates the NM tag and replaces
359 MD tags if they are wrong.
361 * The view command now recognizes and optionally prints FLAG in HEXs or
362 strings to make a SAM file more friendly to human eyes. This is a
363 samtools-C extension, not implemented in Picard for the time
364 being. Please type `samtools view -?' for more information.
366 * BAM files now have an end-of-file (EOF) marker to facilitate
367 truncation detection. A warning will be given if an on-disk BAM file
368 does not have this marker. The warning will be seen on BAM files
369 generated by an older version of samtools. It does NO harm.
371 * New key bindings in tview: `r' to show read names and `s' to show
372 reference skip (N operation) as deletions.
374 * Fixed a bug in `samtools merge -n'.
376 * Samtools merge now optionally copies the header of a user specified
377 SAM file to the resultant BAM output.
379 * Samtools pileup/tview works with a CIGAR with the first or the last
380 operation is an indel.
382 * Fixed a bug in bam_aux_get().
385 Changes in other utilies:
387 * Fixed wrong FLAG in maq2sam.
390 (0.1.6: 2 September 2009, r453)
394 Beta Release 0.1.5 (7 July, 2009)
395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399 * Support opening a BAM alignment on FTP. Users can now use "tview" to
400 view alignments at the NCBI ftp site. Please read manual for more
403 * In library, propagate errors rather than exit or complain assertion
406 * Simplified the building system and fixed compiling errors caused by
409 * Fixed an issue about lost header information when a SAM is imported
412 * Implemented "samtool.pl varFilter" which filters both SNPs and short
413 indels. This command replaces "indelFilter".
415 * Implemented "samtools.pl pileup2fq" to generate FASTQ consensus from
418 * In pileup, cap mapping quality at 60. This helps filtering when
419 different aligners are in use.
421 * In pileup, allow to output variant sites only.
423 * Made pileup generate correct calls in repetitive region. At the same
424 time, I am considering to implement a simplified model in SOAPsnp,
425 although this has not happened yet.
427 * In view, added '-u' option to output BAM without compression. This
428 option is preferred when the output is piped to other commands.
430 * In view, added '-l' and '-r' to get the alignments for one library or
431 read group. The "@RG" header lines are now partially parsed.
433 * Do not include command line utilities to libbam.a.
435 * Fixed memory leaks in pileup and bam_view1().
437 * Made faidx more tolerant to empty lines right before or after FASTA >
441 Changes in other utilities:
443 * Updated novo2sam.pl by Colin Hercus, the key developer of novoalign.
446 This release involves several modifications to the key code base which
447 may potentially introduce new bugs even though we have tried to minimize
448 this by testing on several examples. Please let us know if you catch
451 (0.1.5: 7 July 2009, r373)
455 Beta Release 0.1.4 (21 May, 2009)
456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
460 * Added the 'rmdupse' command: removing duplicates for SE reads.
462 * Fixed a critical bug in the indel caller: clipped alignments are not
465 * Fixed a bug in the tview: gapped alignment may be incorrectly
468 * Unified the interface to BAM and SAM I/O. This is done by
469 implementing a wrapper on top of the old APIs and therefore old APIs
470 are still valid. The new I/O APIs also recognize the @SQ header
473 * Generate the MD tag.
475 * Generate "=" bases. However, the indel caller will not work when "="
478 * Enhanced support of color-read display (by Nils Homer).
480 * Implemented the GNU building system. However, currently the building
481 system does not generate libbam.a. We will improve this later. For
482 the time being, `make -f Makefile.generic' is preferred.
484 * Fixed a minor bug in pileup: the first read in a chromosome may be
487 * Fixed bugs in bam_aux.c. These bugs do not affect other components as
488 they were not used previously.
490 * Output the 'SM' tag from maq2sam.
492 (0.1.4: 21 May 2009, r297)
496 Beta Release 0.1.3 (15 April, 2009)
497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
499 Notable changes in SAMtools:
501 * SAMtools is more consistent with the specification: a) '*' in the
502 QUAL field is allowed; b) the field separator is TAB only and SPACE
503 is treated as a character in a field; c) empty header is allowed.
505 * Implemented GLFv3 support in pileup.
507 * Fixed a severe bug in fixmate: strand information is wrongly
510 * Fixed a bug in alignment retrieval: alignments bridging n*16384bp are
511 not correctly retrieved sometimes.
513 * Fixed a bug in rmdup: segfault if unmapped reads are present.
515 * Move indel_filter.pl to samtools.pl and improved the filtering by
516 checking the actual number of alignments containing indels. The indel
517 pileup line is also changed a little to make this filtration easier.
519 * Fixed a minor bug in indexing: the bin number of an unmapped read is
522 * Added `flagstat' command to show statistics on the FLAG field.
524 * Improved indel caller by setting the maximum window size in local
527 Changes in other utilities:
529 * Fixed a bug in maq2sam: a tag name is obsolete.
531 * Improvement to wgsim: a) added support for SOLiD read simulation; b)
532 show the number of substitutions/indels/errors in read name; c)
533 considerable code clean up.
535 * Various converters: improved functionality in general.
537 * Updated the example SAM due to the previous bug in fixmate.
539 (0.1.3: 15 April 2009, r227)
543 Beta Release 0.1.2 (28 January, 2008)
544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
546 Notable changes in SAMtools:
548 * Implemented a Bayesian indel caller. The new caller generate scores
549 and genotype and is potentially more accurate than Maq's indel
550 caller. The pileup format is also changed accordingly.
552 * Implemented rmdup command: remove potential PCR duplicates. Note that
553 this command ONLY works for FR orientation and requires ISIZE is
556 * Added fixmate command: fill in mate coordinates, ISIZE and mate
557 related flags from a name-sorted alignment.
559 * Fixed a bug in indexing: reads bridging 16x kbp were not retrieved.
561 * Allow to select reads shown in the pileup output with a mask.
563 * Generate GLFv2 from pileup.
565 * Added two more flags for flagging PCR/optical duplicates and for QC
568 * Fixed a bug in sort command: name sorting for large alignment did not
571 * Allow to completely disable RAZF (using Makefile.lite) as some people
572 have problem to compile it.
574 * Fixed a bug in import command when there are reads without
577 * Fixed a bug in tview: clipping broke the alignment viewer.
579 * Fixed a compiling error when _NO_CURSES is applied.
581 * Fixed a bug in merge command.
583 Changes in other utilities:
585 * Added wgsim, a paired-end reads simulator. Wgsim was adapted from
586 maq's reads simulator. Colin Hercus further improved it to allow
589 * Added wgsim_eval.pl, a script that evaluates the accuracy of
590 alignment on reads generated by wgsim.
592 * Added soap2sam.pl, a SOAP2->SAM converter. This converter does not
593 work properly when multiple hits are output.
595 * Added bowtie2sam.pl, a Bowtie->SAM converter. Only the top hit will
596 be retained when multiple hits are present.
598 * Fixed a bug in export2sam.pl for QC reads.
600 * Support RG tag at MAQ->SAM converter.
602 * Added novo2sam.pl, a NovoAlign->SAM converter. Multiple hits and
603 indel are not properly handled, though.
605 * Added zoom2sam.pl, a ZOOM->SAM converter. It only works with the
606 default Illumina output.
608 (0.1.2: 28 January 2008; r116)
612 Beta Release 0.1.1 (22 December, 2008)
613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
615 The is the first public release of samtools. For more information,
616 please check the manual page `samtools.1' and the samtools website
617 http://samtools.sourceforge.net