Mention ‘SAMtools’ in libbam-dev's description, to make it easier to find with apt...
[samtools.git] / NEWS
1 Beta Release 0.1.18 (2 September, 2011)
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4 Notable changes in samtools:
5
6  * Support the new =/X CIGAR operators (by Peter Cock).
7
8  * Allow to subsample BAM while keeping the pairing intact (view -s).
9
10  * Implemented variant distance bias as a new filter (by Petr Danecek).
11
12  * Bugfix: huge memory usage during indexing
13
14  * Bugfix: use of uninitialized variable in mpileup (rare)
15
16  * Bugfix: wrong BAQ probability (rare)
17
18 Notable changes in bcftools:
19
20  * Support indel in the contrast caller.
21
22  * Bugfix: LRT2=nan in rare cases
23
24 (0.1.18: 2 September 2011, r982:295)
25
26
27
28 Beta Release 0.1.17 (6 July, 2011)
29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
31 With the maturity of `mpileup' and the lack of update in the `pileup' command,
32 the `pileup' command is now formally dropped. Most of the pileup functionality,
33 such as outputting mapping quality and read positions, have been added
34 `mpileup'.
35
36 Since this release, `bcftools view' is able to perform contrast SNP calling
37 (option -T) for discovering de novo and/or somatic mutations between a pair of
38 samples or in a family trio. Potential mutations are scored by a log likelihood
39 ratio, which is very simple in math, but should be comparable to more
40 sophisticated methods. Note that getting the score is only the very first step.
41 A lot more need to be done to reduce systematical errors due to mapping and
42 reference errors and structural variations.
43
44 Other notable changes in samtools:
45
46  * Improved sorting order checking during indexing.
47
48  * Improved region parsing. Colons in reference sequence names are parsed
49    properly.
50
51  * Fixed an issue where mpileup does not apply BAQ for the first few reads when
52    a region is specified.
53
54  * Fixed an issue where `faidx' does not work with FASTA files with long lines.
55
56  * Bugfix: wrong SP genotype information in the BCF output.
57
58 Other notable changes in bcftools:
59
60  * Output the ML esitmate of the allele count.
61
62  * Added the HWE plus F<0 filter to varFilter. For multiple samples, it
63    effectively filters false heterozygous calls around centromeres.
64
65  * For association mapping, perform both 1-degree and 2-degree test. The
66    2-degree test is conservative but more robust to HWE violation.
67
68 (0.1.17: 6 July 2011, r973:277)
69
70
71
72 Beta Release 0.1.16 (21 April, 2011)
73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74
75 Notable changes in samtools:
76
77  * Support the new SAM/BAM type `B' in the latest SAM spec v1.4.
78
79  * When the output file of `samtools merge' exists, do not overwrite it unless
80    a new command-line option `-f' is applied.
81
82  * Bugfix: BED support is not working when the input BED is not sorted.
83
84  * Bugfix: some reads without coordinates but given on the reverse strand are
85    lost in merging.
86
87 Notable changes in bcftools:
88
89  * Code cleanup: separated max-likelihood inference and Bayesian inference.
90
91  * Test Hardy-Weinberg equilibrium with a likelihood-ratio test.
92
93  * Provided another association test P-value by likelihood-ratio test.
94
95  * Use Brent's method to estimate the site allele frequency when EM converges
96    slowly. The resulting ML estimate of allele frequnecy is more accurate.
97
98  * Added the `ldpair' command, which computes r^2 between SNP pairs given in
99    an input file.
100
101 Also, the `pileup' command, which has been deprecated by `mpileup' since
102 version 0.1.10, will be dropped in the next release. The old `pileup' command
103 is substandard and causing a lot of confusion.
104
105 (0.1.16: 21 April 2011, r963:234)
106
107
108
109 Beta Release 0.1.15 (10 April, 2011)
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111
112 Noteable changes:
113
114  * Allow to perform variant calling or to extract information in multiple
115    regions specified by a BED file (`samtools mpileup -l', `samtools view -L'
116    and `bcftools view -l').
117
118  * Added the `depth' command to samtools to compute the per-base depth with a
119    simpler interface. File `bam2depth.c', which implements this command, is the
120    recommended example on how to use the mpileup APIs.
121
122  * Estimate genotype frequencies with ML; perform chi^2 based Hardy-Weinberg
123    test using this estimate.
124
125  * For `samtools view', when `-R' is specified, drop read groups in the header
126    that are not contained in the specified file.
127
128  * For `samtools flagstat', separate QC-pass and QC-fail reads.
129
130  * Improved the command line help of `samtools mpileup' and `bcftools view'.
131
132  * Use a global variable to control the verbose level of samtools stderr
133    output. Nonetheless, it has not been full utilized.
134
135  * Fixed an issue in association test which may report false associations,
136    possibly due to floating point underflow.
137
138 (0.1.15: 10 April 2011, r949:203)
139
140
141
142 Beta release 0.1.14 (21 March, 2011)
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144
145 This release implements a method for testing associations for case-control
146 data. The method does not call genotypes but instead sums over all genotype
147 configurations to compute a chi^2 based test statistics. It can be potentially
148 applied to comparing a pair of samples (e.g. a tumor-normal pair), but this
149 has not been evaluated on real data.
150
151 Another new feature is to make X chromosome variant calls when female and male
152 samples are both present. The user needs to provide a file indicating the
153 ploidy of each sample (see also manual bcftools/bcftools.1).
154
155 Other notable changes:
156
157  * Added `bcftools view -F' to parse BCF files generated by samtools r921 or
158    older which encodes PL in a different way.
159
160  * Changed the behavior of `bcftools view -s'. Now when a list of samples is
161    provided, the samples in the output will be reordered to match the ordering
162    in the sample list. This change is mainly designed for association test.
163
164  * Sped up `bcftools view -v' for target sequencing given thousands of samples.
165    Also added a new option `view -d' to skip loci where only a few samples are
166    covered by reads.
167
168  * Dropped HWE test. This feature has never been implemented properly. An EM
169    should be much better. To be implemented in future.
170
171  * Added the `cat' command to samtools. This command concatenate BAMs with
172    identical sequence dictionaries in an efficient way. Modified from bam_cat.c
173    written by Chris Saunders.
174
175  * Added `samtools view -1' to write BAMs at a low compression level but twice
176    faster to create. The `sort' command generates temporary files at a low
177    compression level as well.
178
179  * Added `samtools mpileup -6' to accept "BAM" with Illumina 1.3+ quality
180    strings (strictly speaking, such a file is not BAM).
181
182  * Added `samtools mpileup -L' to skip INDEL calling in regions with
183    excessively high coverage. Such regions dramatically slow down mpileup.
184
185  * Updated `misc/export2sam.pl', provided by Chris Saunders from Illumina Inc.
186
187 (0.1.14: 21 March 2011, r933:170)
188
189
190
191 Beta release 0.1.13 (1 March, 2011)
192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193
194 The most important though largely invisible modification is the change of the
195 order of genotypes in the PL VCF/BCF tag. This is to conform the upcoming VCF
196 spec v4.1. The change means that 0.1.13 is not backward compatible with VCF/BCF
197 generated by samtools older than r921 inclusive.  VCF/BCF generated by the new
198 samtools will contain a line `##fileformat=VCFv4.1' as well as the samtools
199 version number.
200
201 Single Individual Haplotyping (SIH) is added as an experimental feature. It
202 originally aims to produce haploid consensus from fosmid pool sequencing, but
203 also works with short-read data. For short reads, phased blocks are usually too
204 short to be useful in many applications, but they can help to rule out part of
205 SNPs close to INDELs or between copies of CNVs.
206
207
208 Other notable changes in samtools:
209
210  * Construct per-sample consensus to reduce the effect of nearby SNPs in INDEL
211    calling. This reduces the power but improves specificity.
212
213  * Improved sorting order checking in indexing. Now indexing is the preferred way
214    to check if a BAM is sorted.
215
216  * Added a switch `-E' to mpileup and calmd. This option uses an alternative way
217    to apply BAQ, which increases sensistivity, especially to MNPs, at the cost of
218    a little loss in specificity.
219
220  * Added `mpileup -A' to allow to use reads in anomalous pairs in SNP calling.
221
222  * Added `mpileup -m' to allow fine control of the collection of INDEL candidates.
223
224  * Added `mpileup -S' to compute per-sample strand bias P-value.
225
226  * Added `mpileup -G' to exclude read groups in variant calling.
227
228  * Fixed segfault in indel calling related to unmapped and refskip reads.
229
230  * Fixed an integer overflow in INDEL calling. This bug produces wrong INDEL
231    genotypes for longer short INDELs, typically over 10bp.
232
233  * Fixed a bug in tview on big-endian machines.
234
235  * Fixed a very rare memory issue in bam_md.c
236
237  * Fixed an out-of-boundary bug in mpileup when the read base is `N'.
238
239  * Fixed a compiling error when the knetfile library is not used. Fixed a
240    library compiling error due to the lack of bam_nt16_nt4_table[] table.
241    Suppress a compiling warning related to the latest zlib.
242
243
244 Other notable changes in bcftools:
245
246  * Updated the BCF spec.
247
248  * Added the `FQ' VCF INFO field, which gives the phred-scaled probability
249    of all samples being the same (identical to the reference or all homozygous
250    variants). Option `view -f' has been dropped.
251
252  * Implementated of "vcfutils.pl vcf2fq" to generate a consensus sequence
253    similar to "samtools.pl pileup2fq".
254
255  * Make sure the GT FORMAT field is always the first FORMAT to conform the VCF
256    spec. Drop bcf-fix.pl.
257
258  * Output bcftools specific INFO and FORMAT in the VCF header.
259
260  * Added `view -s' to call variants from a subset of samples.
261
262  * Properly convert VCF to BCF with a user provided sequence dictionary. Nonetheless,
263    custom fields are still unparsed and will be stored as a missing value.
264
265  * Fixed a minor bug in Fisher's exact test; the results are rarely changed.
266
267
268 (0.1.13: 1 March 2011, r926:134)
269
270
271
272 Beta release 0.1.12a (2 December, 2010)
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274
275 This is another bug fix release:
276
277  * Fixed a memory violation in mpileup, which causes segfault. Release
278    0.1.9 and above are affected.
279
280  * Fixed a memory violation in the indel caller, which does not causes
281    segfault, but may potentially affect deletion calls in an unexpected
282    way. Release 0.1.10 and above are affected.
283
284  * Fixed a bug in computing r-square in bcftools. Few are using this
285    functionality and it only has minor effect.
286
287  * Fixed a memory leak in bam_fetch().
288
289  * Fixed a bug in writing meta information to the BAM index for the last
290    sequence. This bug is invisible to most users, but it is a bug anyway.
291
292  * Fixed a bug in bcftools which causes false "DP4=0,0,0,0" annotations.
293
294 (0.1.12: 2 December 2010, r862)
295
296
297
298 Beta release 0.1.11 (21 November, 2010)
299 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300
301 This is mainly a bug fix release:
302
303  * Fixed a bug in random retrieval (since 0.1.8). It occurs when reads
304    are retrieved from a small region containing no reads.
305
306  * Fixed a bug in pileup (since 0.1.9). The bug causes an assertion
307    failure when the first CIGAR operation is a deletion.
308
309  * Improved fault tolerence in remote access.
310
311 One minor feature has been implemented in bcftools:
312
313  * Added a reference-free variant calling mode. In this mode, a site is
314    regarded as a variat iff the sample(s) contains two or more alleles;
315    the meaning of the QUAL field in the VCF output is changed
316    accordingly. Effectively, the reference allele is irrelevant to the
317    result in the new mode, although the reference sequence has to be
318    used in realignment when SAMtools computes genotype likelihoods.
319
320 In addition, since 0.1.10, the `pileup' command has been deprecated by
321 `mpileup' which is more powerful and more accurate. The `pileup' command
322 will not be removed in the next few releases, but new features will not
323 be added.
324
325 (0.1.11: 21 November 2010, r851)
326
327
328
329 Beta Release 0.1.10 (16 November, 2010)
330 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331
332 This release is featured as the first major improvement to the indel
333 caller. The method is similar to the old one implemented in the pileup
334 command, but the details are handled more carefully both in theory and
335 in practice. As a result, the new indel caller usually gives more
336 accurate indel calls, though at the cost of sensitivity. The caller is
337 implemented in the mpileup command and is invoked by default. It works
338 with multiple samples.
339
340 Other notable changes:
341
342  * With the -r option, the calmd command writes the difference between
343    the original base quality and the BAQ capped base quality at the BQ
344    tag but does not modify the base quality. Please use -Ar to overwrite
345    the original base quality (the 0.1.9 behavior).
346
347  * Allow to set a maximum per-sample read depth to reduce memory. In
348    0.1.9, most of memory is wasted for the ultra high read depth in some
349    regions (e.g. the chr1 centromere).
350
351  * Optionally write per-sample read depth and per-sample strand bias
352    P-value.
353
354  * Compute equal-tail (Bayesian) credible interval of site allele
355    frequency at the CI95 VCF annotation.
356
357  * Merged the vcfutils.pl varFilter and filter4vcf for better SNP/indel
358    filtering.
359
360 (0.1.10: 16 November 2010, r829)
361
362
363
364 Beta Release 0.1.9 (27 October, 2010)
365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366
367 This release is featured as the first major improvement to the samtools'
368 SNP caller.  It comes with a revised MAQ error model, the support of
369 multi-sample SNP calling and the computation of base alignment quality
370 (BAQ).
371
372 The revised MAQ error model is based on the original model. It solves an
373 issue of miscalling SNPs in repetitive regions. Althought such SNPs can
374 usually be filtered at a later step, they mess up unfiltered calls. This
375 is a theoretical flaw in the original model. The revised MAQ model
376 deprecates the orginal MAQ model and the simplified SOAPsnp model.
377
378 Multi-sample SNP calling is separated in two steps. The first is done by
379 samtools mpileup and the second by a new program, bcftools, which is
380 included in the samtools source code tree. Multi-sample SNP calling also
381 works for single sample and has the advantage of enabling more powerful
382 filtration. It is likely to deprecate pileup in future once a proper
383 indel calling method is implemented.
384
385 BAQ is the Phred-scaled probability of a read base being wrongly
386 aligned. Capping base quality by BAQ has been shown to be very effective
387 in suppressing false SNPs caused by misalignments around indels or in
388 low-complexity regions with acceptable compromise on computation
389 time. This strategy is highly recommended and can be used with other SNP
390 callers as well.
391
392 In addition to the three major improvements, other notable changes are:
393
394  * Changes to the pileup format. A reference skip (the N CIGAR operator)
395    is shown as '<' or '>' depending on the strand. Tview is also changed
396    accordingly.
397
398  * Accelerated pileup. The plain pileup is about 50% faster.
399
400  * Regional merge. The merge command now accepts a new option to merge
401    files in a specified region.
402
403  * Fixed a bug in bgzip and razip which causes source files to be
404    deleted even if option -c is applied.
405
406  * In APIs, propogate errors to downstream callers and make samtools
407    return non-zero values once errors occur.
408
409 (0.1.9: 27 October 2010, r783)
410
411
412
413 Beta Release 0.1.8 (11 July, 2010)
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
415
416 Notable functional changes:
417
418  * Added the `reheader' command which replaces a BAM header with a new
419    header. This command is much faster than replacing header by
420    BAM->SAM->BAM conversions.
421
422  * Added the `mpileup' command which computes the pileup of multiple
423    alignments.
424
425  * The `index' command now stores the number of mapped and unmapped
426    reads in the index file. This information can be retrieved quickly by
427    the new `idxstats' command.
428
429  * By default, pileup used the SOAPsnp model for SNP calling. This
430    avoids the floating overflow in the MAQ model which leads to spurious
431    calls in repetitive regions, although these calls will be immediately
432    filtered by varFilter.
433
434  * The `tview' command now correctly handles CIGARs like 7I10M and
435    10M1P1I10M which cause assertion failure in earlier versions.
436
437  * Tview accepts a region like `=10,000' where `=' stands for the
438    current sequence name. This saves typing for long sequence names.
439
440  * Added the `-d' option to `pileup' which avoids slow indel calling
441    in ultradeep regions by subsampling reads locally.
442
443  * Added the `-R' option to `view' which retrieves alignments in read
444    groups listed in the specified file.
445
446 Performance improvements:
447
448  * The BAM->SAM conversion is up to twice faster, depending on the
449    characteristic of the input.
450
451  * Parsing SAM headers with a lot of reference sequences is now much
452    faster.
453
454  * The number of lseek() calls per query is reduced when the query
455    region contains no read alignments.
456
457 Bug fixes:
458
459  * Fixed an issue in the indel caller that leads to miscall of indels.
460    Note that this solution may not work well when the sequencing indel
461    error rate is higher than the rate of SNPs.
462
463  * Fixed another issue in the indel caller which may lead to incorrect
464    genotype.
465
466  * Fixed a bug in `sort' when option `-o' is applied.
467
468  * Fixed a bug in `view -r'.
469
470 APIs and other changes:
471
472  * Added iterator interfaces to random access and pileup. The callback
473    interfaces directly call the iterator interfaces.
474
475  * The BGZF blocks holding the BAM header are indepedent of alignment
476    BGZF blocks. Alignment records shorter than 64kB is guaranteed to be
477    fully contained in one BGZF block. This change is fully compatible
478    with the old version of samtools/picard.
479
480 Changes in other utilities:
481
482  * Updated export2sam.pl by Chris Saunders.
483
484  * Improved the sam2vcf.pl script.
485
486  * Added a Python version of varfilter.py by Aylwyn Scally.
487
488 (0.1.8: 11 July 2010, r613)
489
490
491
492 Beta Release 0.1.7 (10 November, 2009)
493 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
494
495 Notable changes:
496
497  * Improved the indel caller in complex scenariors, in particular for
498    long reads. The indel caller is now able to make reasonable indel
499    calls from Craig Venter capillary reads.
500
501  * Rewrote single-end duplicate removal with improved
502    performance. Paired-end reads are not touched.
503
504  * Duplicate removal is now library aware. Samtools remove potential
505    PCR/optical dupliates inside a library rather than across libraries.
506
507  * SAM header is now fully parsed, although this functionality is not
508    used in merging and so on.
509
510  * In samtools merge, optionally take the input file name as RG-ID and
511    attach the RG tag to each alignment.
512
513  * Added FTP support in the RAZF library. RAZF-compressed reference
514    sequence can be retrieved remotely.
515
516  * Improved network support for Win32.
517
518  * Samtools sort and merge are now stable.
519
520 Changes in other utilities:
521
522  * Implemented sam2vcf.pl that converts the pileup format to the VCF
523    format.
524
525  * This release of samtools is known to work with the latest
526    Bio-Samtools Perl module.
527
528 (0.1.7: 10 November 2009, r510)
529
530
531
532 Beta Release 0.1.6 (2 September, 2009)
533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
534
535 Notable changes:
536
537  * In tview, do not show a blank screen when no reads mapped to the
538    corresponding region.
539
540  * Implemented native HTTP support in the BGZF library. Samtools is now
541    able to directly open a BAM file on HTTP. HTTP proxy is also
542    supported via the "http_proxy" environmental variable.
543
544  * Samtools is now compitable with the MinGW (win32) compiler and the
545    PDCurses library.
546
547  * The calmd (or fillmd) command now calculates the NM tag and replaces
548    MD tags if they are wrong.
549
550  * The view command now recognizes and optionally prints FLAG in HEXs or
551    strings to make a SAM file more friendly to human eyes. This is a
552    samtools-C extension, not implemented in Picard for the time
553    being. Please type `samtools view -?' for more information.
554
555  * BAM files now have an end-of-file (EOF) marker to facilitate
556    truncation detection. A warning will be given if an on-disk BAM file
557    does not have this marker. The warning will be seen on BAM files
558    generated by an older version of samtools. It does NO harm.
559
560  * New key bindings in tview: `r' to show read names and `s' to show
561    reference skip (N operation) as deletions.
562
563  * Fixed a bug in `samtools merge -n'.
564
565  * Samtools merge now optionally copies the header of a user specified
566    SAM file to the resultant BAM output.
567
568  * Samtools pileup/tview works with a CIGAR with the first or the last
569    operation is an indel.
570
571  * Fixed a bug in bam_aux_get().
572
573
574 Changes in other utilies:
575
576  * Fixed wrong FLAG in maq2sam.
577
578
579 (0.1.6: 2 September 2009, r453)
580
581
582
583 Beta Release 0.1.5 (7 July, 2009)
584 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
585
586 Notable changes:
587
588  * Support opening a BAM alignment on FTP. Users can now use "tview" to
589    view alignments at the NCBI ftp site. Please read manual for more
590    information.
591
592  * In library, propagate errors rather than exit or complain assertion
593    failure.
594
595  * Simplified the building system and fixed compiling errors caused by
596    zlib<1.2.2.1.
597
598  * Fixed an issue about lost header information when a SAM is imported
599    with "view -t".
600
601  * Implemented "samtool.pl varFilter" which filters both SNPs and short
602    indels. This command replaces "indelFilter".
603
604  * Implemented "samtools.pl pileup2fq" to generate FASTQ consensus from
605    pileup output.
606
607  * In pileup, cap mapping quality at 60. This helps filtering when
608    different aligners are in use.
609
610  * In pileup, allow to output variant sites only.
611
612  * Made pileup generate correct calls in repetitive region. At the same
613    time, I am considering to implement a simplified model in SOAPsnp,
614    although this has not happened yet.
615
616  * In view, added '-u' option to output BAM without compression. This
617    option is preferred when the output is piped to other commands.
618
619  * In view, added '-l' and '-r' to get the alignments for one library or
620    read group. The "@RG" header lines are now partially parsed.
621
622  * Do not include command line utilities to libbam.a.
623
624  * Fixed memory leaks in pileup and bam_view1().
625
626  * Made faidx more tolerant to empty lines right before or after FASTA >
627    lines.
628
629
630 Changes in other utilities:
631
632  * Updated novo2sam.pl by Colin Hercus, the key developer of novoalign.
633
634
635 This release involves several modifications to the key code base which
636 may potentially introduce new bugs even though we have tried to minimize
637 this by testing on several examples. Please let us know if you catch
638 bugs.
639
640 (0.1.5: 7 July 2009, r373)
641
642
643
644 Beta Release 0.1.4 (21 May, 2009)
645 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
646
647 Notable changes:
648
649  * Added the 'rmdupse' command: removing duplicates for SE reads.
650
651  * Fixed a critical bug in the indel caller: clipped alignments are not
652    processed correctly.
653
654  * Fixed a bug in the tview: gapped alignment may be incorrectly
655    displayed.
656
657  * Unified the interface to BAM and SAM I/O. This is done by
658    implementing a wrapper on top of the old APIs and therefore old APIs
659    are still valid. The new I/O APIs also recognize the @SQ header
660    lines.
661
662  * Generate the MD tag.
663
664  * Generate "=" bases. However, the indel caller will not work when "="
665    bases are present.
666
667  * Enhanced support of color-read display (by Nils Homer).
668
669  * Implemented the GNU building system. However, currently the building
670    system does not generate libbam.a. We will improve this later. For
671    the time being, `make -f Makefile.generic' is preferred.
672
673  * Fixed a minor bug in pileup: the first read in a chromosome may be
674    skipped.
675
676  * Fixed bugs in bam_aux.c. These bugs do not affect other components as
677    they were not used previously.
678
679  * Output the 'SM' tag from maq2sam.
680
681 (0.1.4: 21 May 2009, r297)
682
683
684
685 Beta Release 0.1.3 (15 April, 2009)
686 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
687
688 Notable changes in SAMtools:
689
690  * SAMtools is more consistent with the specification: a) '*' in the
691    QUAL field is allowed; b) the field separator is TAB only and SPACE
692    is treated as a character in a field; c) empty header is allowed.
693
694  * Implemented GLFv3 support in pileup.
695
696  * Fixed a severe bug in fixmate: strand information is wrongly
697    overwritten.
698
699  * Fixed a bug in alignment retrieval: alignments bridging n*16384bp are
700    not correctly retrieved sometimes.
701
702  * Fixed a bug in rmdup: segfault if unmapped reads are present.
703
704  * Move indel_filter.pl to samtools.pl and improved the filtering by
705    checking the actual number of alignments containing indels. The indel
706    pileup line is also changed a little to make this filtration easier.
707
708  * Fixed a minor bug in indexing: the bin number of an unmapped read is
709    wrongly calculated.
710
711  * Added `flagstat' command to show statistics on the FLAG field.
712
713  * Improved indel caller by setting the maximum window size in local
714    realignment.
715
716 Changes in other utilities:
717
718  * Fixed a bug in maq2sam: a tag name is obsolete.
719
720  * Improvement to wgsim: a) added support for SOLiD read simulation; b)
721    show the number of substitutions/indels/errors in read name; c)
722    considerable code clean up.
723
724  * Various converters: improved functionality in general.
725
726  * Updated the example SAM due to the previous bug in fixmate.
727
728 (0.1.3: 15 April 2009, r227)
729
730
731
732 Beta Release 0.1.2 (28 January, 2008)
733 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
734
735 Notable changes in SAMtools:
736
737  * Implemented a Bayesian indel caller. The new caller generate scores
738    and genotype and is potentially more accurate than Maq's indel
739    caller. The pileup format is also changed accordingly.
740
741  * Implemented rmdup command: remove potential PCR duplicates. Note that
742    this command ONLY works for FR orientation and requires ISIZE is
743    correctly set.
744
745  * Added fixmate command: fill in mate coordinates, ISIZE and mate
746    related flags from a name-sorted alignment.
747
748  * Fixed a bug in indexing: reads bridging 16x kbp were not retrieved.
749
750  * Allow to select reads shown in the pileup output with a mask.
751
752  * Generate GLFv2 from pileup.
753
754  * Added two more flags for flagging PCR/optical duplicates and for QC
755    failure.
756
757  * Fixed a bug in sort command: name sorting for large alignment did not
758    work.
759
760  * Allow to completely disable RAZF (using Makefile.lite) as some people
761    have problem to compile it.
762
763  * Fixed a bug in import command when there are reads without
764    coordinates.
765
766  * Fixed a bug in tview: clipping broke the alignment viewer.
767
768  * Fixed a compiling error when _NO_CURSES is applied.
769
770  * Fixed a bug in merge command.
771
772 Changes in other utilities:
773
774  * Added wgsim, a paired-end reads simulator. Wgsim was adapted from
775    maq's reads simulator. Colin Hercus further improved it to allow
776    longer indels.
777
778  * Added wgsim_eval.pl, a script that evaluates the accuracy of
779    alignment on reads generated by wgsim.
780
781  * Added soap2sam.pl, a SOAP2->SAM converter. This converter does not
782    work properly when multiple hits are output.
783
784  * Added bowtie2sam.pl, a Bowtie->SAM converter. Only the top hit will
785    be retained when multiple hits are present.
786
787  * Fixed a bug in export2sam.pl for QC reads.
788
789  * Support RG tag at MAQ->SAM converter.
790
791  * Added novo2sam.pl, a NovoAlign->SAM converter. Multiple hits and
792    indel are not properly handled, though.
793
794  * Added zoom2sam.pl, a ZOOM->SAM converter. It only works with the
795    default Illumina output.
796
797 (0.1.2: 28 January 2008; r116)
798
799
800
801 Beta Release 0.1.1 (22 December, 2008)
802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
803
804 The is the first public release of samtools. For more information,
805 please check the manual page `samtools.1' and the samtools website
806 http://samtools.sourceforge.net