forked from samtools/samtools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stats.c
1525 lines (1376 loc) · 61.3 KB
/
stats.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* stats.c -- This is the former bamcheck integrated into samtools/htslib.
Copyright (C) 2012-2014 Genome Research Ltd.
Author: Petr Danecek <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE. */
/* Assumptions, approximations and other issues:
- GC-depth graph does not split reads, the starting position determines which bin is incremented.
There are small overlaps between bins (max readlen-1). However, the bins are big (20k).
- coverage distribution ignores softclips and deletions
- some stats require sorted BAMs
- GC content graph can have an untidy, step-like pattern when BAM contains multiple read lengths.
- 'bases mapped' (stats->nbases_mapped) is calculated from read lengths given by BAM (core.l_qseq)
- With the -t option, the whole reads are used. Except for the number of mapped bases (cigar)
counts, no splicing is done, no indels or soft clips are considered, even small overlap is
good enough to include the read in the stats.
- GC content of reads not calculated for "=" sequences
*/
#include <unistd.h> // for isatty()
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <math.h>
#include <ctype.h>
#include <getopt.h>
#include <errno.h>
#include <assert.h>
#include <zlib.h> // for crc32
#include <htslib/faidx.h>
#include <htslib/sam.h>
#include <htslib/hts.h>
#include "sam_header.h"
#include <htslib/khash_str2int.h>
#include "samtools.h"
#include <htslib/khash.h>
#include "stats_isize.h"
#define BWA_MIN_RDLEN 35
// From the spec
// If 0x4 is set, no assumptions can be made about RNAME, POS, CIGAR, MAPQ, bits 0x2, 0x10, 0x100 and 0x800, and the bit 0x20 of the previous read in the template.
#define IS_PAIRED_AND_MAPPED(bam) (((bam)->core.flag&BAM_FPAIRED) && !((bam)->core.flag&BAM_FUNMAP) && !((bam)->core.flag&BAM_FMUNMAP))
#define IS_PROPERLYPAIRED(bam) (((bam)->core.flag&(BAM_FPAIRED|BAM_FPROPER_PAIR)) == (BAM_FPAIRED|BAM_FPROPER_PAIR) && !((bam)->core.flag&BAM_FUNMAP))
#define IS_UNMAPPED(bam) ((bam)->core.flag&BAM_FUNMAP)
#define IS_REVERSE(bam) ((bam)->core.flag&BAM_FREVERSE)
#define IS_MATE_REVERSE(bam) ((bam)->core.flag&BAM_FMREVERSE)
#define IS_READ1(bam) ((bam)->core.flag&BAM_FREAD1)
#define IS_READ2(bam) ((bam)->core.flag&BAM_FREAD2)
#define IS_DUP(bam) ((bam)->core.flag&BAM_FDUP)
// The GC-depth graph works as follows: split the reference sequence into
// segments and calculate GC content and depth in each bin. Then sort
// these segments by their GC and plot the depth distribution by means
// of 10th, 25th, etc. depth percentiles.
typedef struct
{
float gc;
uint32_t depth;
}
gc_depth_t;
// For coverage distribution, a simple pileup
typedef struct
{
int64_t pos;
int size, start;
int *buffer;
}
round_buffer_t;
typedef struct { uint32_t from, to; } pos_t;
typedef struct
{
int npos,mpos,cpos;
pos_t *pos;
}
regions_t;
typedef struct
{
// Parameters
int trim_qual; // bwa trim quality
// Dimensions of the quality histogram holder (quals_1st,quals_2nd), GC content holder (gc_1st,gc_2nd),
// insert size histogram holder
int nquals; // The number of quality bins
int nbases; // The maximum sequence length the allocated array can hold
int nisize; // The maximum insert size that the allocated array can hold - 0 indicates no limit
int ngc; // The size of gc_1st and gc_2nd
int nindels; // The maximum indel length for indel distribution
// Arrays for the histogram data
uint64_t *quals_1st, *quals_2nd;
uint64_t *gc_1st, *gc_2nd;
uint64_t *acgt_cycles;
uint64_t *read_lengths;
uint64_t *insertions, *deletions;
uint64_t *ins_cycles_1st, *ins_cycles_2nd, *del_cycles_1st, *del_cycles_2nd;
isize_t *isize;
// The extremes encountered
int max_len; // Maximum read length
int max_qual; // Maximum quality
float isize_main_bulk; // There are always some unrealistically big insert sizes, report only the main part
int is_sorted;
// Summary numbers
uint64_t total_len;
uint64_t total_len_dup;
uint64_t nreads_1st;
uint64_t nreads_2nd;
uint64_t nreads_filtered;
uint64_t nreads_dup;
uint64_t nreads_unmapped;
uint64_t nreads_single_mapped;
uint64_t nreads_paired_and_mapped;
uint64_t nreads_properly_paired;
uint64_t nreads_paired_tech;
uint64_t nreads_anomalous;
uint64_t nreads_mq0;
uint64_t nbases_mapped;
uint64_t nbases_mapped_cigar;
uint64_t nbases_trimmed; // bwa trimmed bases
uint64_t nmismatches;
uint64_t nreads_QCfailed, nreads_secondary;
struct {
uint32_t names, reads, quals;
} checksum;
// GC-depth related data
uint32_t ngcd, igcd; // The maximum number of GC depth bins and index of the current bin
gc_depth_t *gcd; // The GC-depth bins holder
int gcd_bin_size; // The size of GC-depth bin
int32_t tid, gcd_pos; // Position of the current bin
int32_t pos; // Position of the last read
// Coverage distribution related data
int ncov; // The number of coverage bins
uint64_t *cov; // The coverage frequencies
int cov_min,cov_max,cov_step; // Minimum, maximum coverage and size of the coverage bins
round_buffer_t cov_rbuf; // Pileup round buffer
// Mismatches by read cycle
uint8_t *rseq_buf; // A buffer for reference sequence to check the mismatches against
int mrseq_buf; // The size of the buffer
int32_t rseq_pos; // The coordinate of the first base in the buffer
int32_t nrseq_buf; // The used part of the buffer
uint64_t *mpc_buf; // Mismatches per cycle
// Filters
int filter_readlen;
// Target regions
int nregions, reg_from,reg_to;
regions_t *regions;
// Auxiliary data
int flag_require, flag_filter;
double sum_qual; // For calculating average quality value
samFile* sam;
bam_hdr_t* sam_header;
void *rg_hash; // Read groups to include, the array is null-terminated
faidx_t *fai; // Reference sequence for GC-depth graph
int argc; // Command line arguments to be printed on the output
char **argv;
}
stats_t;
static void error(const char *format, ...);
int is_in_regions(bam1_t *bam_line, stats_t *stats);
void realloc_buffers(stats_t *stats, int seq_len);
// Coverage distribution methods
static inline int coverage_idx(int min, int max, int n, int step, int depth)
{
if ( depth < min )
return 0;
if ( depth > max )
return n-1;
return 1 + (depth - min) / step;
}
static inline int round_buffer_lidx2ridx(int offset, int size, int64_t refpos, int64_t pos)
{
return (offset + (pos-refpos) % size) % size;
}
void round_buffer_flush(stats_t *stats, int64_t pos)
{
int ibuf,idp;
if ( pos==stats->cov_rbuf.pos )
return;
int64_t new_pos = pos;
if ( pos==-1 || pos - stats->cov_rbuf.pos >= stats->cov_rbuf.size )
{
// Flush the whole buffer, but in sequential order,
pos = stats->cov_rbuf.pos + stats->cov_rbuf.size - 1;
}
if ( pos < stats->cov_rbuf.pos )
error("Expected coordinates in ascending order, got %ld after %ld\n", pos,stats->cov_rbuf.pos);
int ifrom = stats->cov_rbuf.start;
int ito = round_buffer_lidx2ridx(stats->cov_rbuf.start,stats->cov_rbuf.size,stats->cov_rbuf.pos,pos-1);
if ( ifrom>ito )
{
for (ibuf=ifrom; ibuf<stats->cov_rbuf.size; ibuf++)
{
if ( !stats->cov_rbuf.buffer[ibuf] )
continue;
idp = coverage_idx(stats->cov_min,stats->cov_max,stats->ncov,stats->cov_step,stats->cov_rbuf.buffer[ibuf]);
stats->cov[idp]++;
stats->cov_rbuf.buffer[ibuf] = 0;
}
ifrom = 0;
}
for (ibuf=ifrom; ibuf<=ito; ibuf++)
{
if ( !stats->cov_rbuf.buffer[ibuf] )
continue;
idp = coverage_idx(stats->cov_min,stats->cov_max,stats->ncov,stats->cov_step,stats->cov_rbuf.buffer[ibuf]);
stats->cov[idp]++;
stats->cov_rbuf.buffer[ibuf] = 0;
}
stats->cov_rbuf.start = (new_pos==-1) ? 0 : round_buffer_lidx2ridx(stats->cov_rbuf.start,stats->cov_rbuf.size,stats->cov_rbuf.pos,pos);
stats->cov_rbuf.pos = new_pos;
}
void round_buffer_insert_read(round_buffer_t *rbuf, int64_t from, int64_t to)
{
if ( to-from >= rbuf->size )
error("The read length too big (%d), please increase the buffer length (currently %d)\n", to-from+1,rbuf->size);
if ( from < rbuf->pos )
error("The reads are not sorted (%ld comes after %ld).\n", from,rbuf->pos);
int ifrom,ito,ibuf;
ifrom = round_buffer_lidx2ridx(rbuf->start,rbuf->size,rbuf->pos,from);
ito = round_buffer_lidx2ridx(rbuf->start,rbuf->size,rbuf->pos,to);
if ( ifrom>ito )
{
for (ibuf=ifrom; ibuf<rbuf->size; ibuf++)
rbuf->buffer[ibuf]++;
ifrom = 0;
}
for (ibuf=ifrom; ibuf<=ito; ibuf++)
rbuf->buffer[ibuf]++;
}
// Calculate the number of bases in the read trimmed by BWA
int bwa_trim_read(int trim_qual, uint8_t *quals, int len, int reverse)
{
if ( len<BWA_MIN_RDLEN ) return 0;
// Although the name implies that the read cannot be trimmed to more than BWA_MIN_RDLEN,
// the calculation can in fact trim it to (BWA_MIN_RDLEN-1). (bwa_trim_read in bwa/bwaseqio.c).
int max_trimmed = len - BWA_MIN_RDLEN + 1;
int l, sum=0, max_sum=0, max_l=0;
for (l=0; l<max_trimmed; l++)
{
sum += trim_qual - quals[ reverse ? l : len-1-l ];
if ( sum<0 ) break;
if ( sum>max_sum )
{
max_sum = sum;
// This is the correct way, but bwa clips from some reason one base less
// max_l = l+1;
max_l = l;
}
}
return max_l;
}
void count_indels(stats_t *stats,bam1_t *bam_line)
{
int is_fwd = IS_REVERSE(bam_line) ? 0 : 1;
int is_1st = IS_READ1(bam_line) ? 1 : 0;
int icig;
int icycle = 0;
int read_len = bam_line->core.l_qseq;
for (icig=0; icig<bam_line->core.n_cigar; icig++)
{
int cig = bam_cigar_op(bam_get_cigar(bam_line)[icig]);
int ncig = bam_cigar_oplen(bam_get_cigar(bam_line)[icig]);
if ( !ncig ) continue; // curiously, this can happen: 0D
if ( cig==BAM_CINS )
{
int idx = is_fwd ? icycle : read_len-icycle-ncig;
if ( idx<0 )
error("FIXME: read_len=%d vs icycle=%d\n", read_len,icycle);
if ( idx >= stats->nbases || idx<0 ) error("FIXME: %d vs %d, %s:%d %s\n", idx,stats->nbases, stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1,bam_get_qname(bam_line));
if ( is_1st )
stats->ins_cycles_1st[idx]++;
else
stats->ins_cycles_2nd[idx]++;
icycle += ncig;
if ( ncig<=stats->nindels )
stats->insertions[ncig-1]++;
continue;
}
if ( cig==BAM_CDEL )
{
int idx = is_fwd ? icycle-1 : read_len-icycle-1;
if ( idx<0 ) continue; // discard meaningless deletions
if ( idx >= stats->nbases ) error("FIXME: %d vs %d\n", idx,stats->nbases);
if ( is_1st )
stats->del_cycles_1st[idx]++;
else
stats->del_cycles_2nd[idx]++;
if ( ncig<=stats->nindels )
stats->deletions[ncig-1]++;
continue;
}
if ( cig!=BAM_CREF_SKIP && cig!=BAM_CHARD_CLIP && cig!=BAM_CPAD )
icycle += ncig;
}
}
int unclipped_length(bam1_t *bam_line)
{
int icig, read_len = bam_line->core.l_qseq;
for (icig=0; icig<bam_line->core.n_cigar; icig++)
{
int cig = bam_cigar_op(bam_get_cigar(bam_line)[icig]);
if ( cig==BAM_CHARD_CLIP )
read_len += bam_cigar_oplen(bam_get_cigar(bam_line)[icig]);
}
return read_len;
}
void count_mismatches_per_cycle(stats_t *stats, bam1_t *bam_line, int read_len)
{
int is_fwd = IS_REVERSE(bam_line) ? 0 : 1;
int icig,iread=0,icycle=0;
int iref = bam_line->core.pos - stats->rseq_pos;
uint8_t *read = bam_get_seq(bam_line);
uint8_t *quals = bam_get_qual(bam_line);
uint64_t *mpc_buf = stats->mpc_buf;
for (icig=0; icig<bam_line->core.n_cigar; icig++)
{
int cig = bam_cigar_op(bam_get_cigar(bam_line)[icig]);
int ncig = bam_cigar_oplen(bam_get_cigar(bam_line)[icig]);
if ( cig==BAM_CINS )
{
iread += ncig;
icycle += ncig;
continue;
}
if ( cig==BAM_CDEL )
{
iref += ncig;
continue;
}
if ( cig==BAM_CSOFT_CLIP )
{
icycle += ncig;
// Soft-clips are present in the sequence, but the position of the read marks a start of the sequence after clipping
// iref += ncig;
iread += ncig;
continue;
}
if ( cig==BAM_CHARD_CLIP )
{
icycle += ncig;
continue;
}
// Ignore H and N CIGARs. The letter are inserted e.g. by TopHat and often require very large
// chunk of refseq in memory. Not very frequent and not noticable in the stats.
if ( cig==BAM_CREF_SKIP || cig==BAM_CHARD_CLIP || cig==BAM_CPAD ) continue;
if ( cig!=BAM_CMATCH && cig!=BAM_CEQUAL && cig!=BAM_CDIFF ) // not relying on precalculated diffs
error("TODO: cigar %d, %s:%d %s\n", cig,stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1,bam_get_qname(bam_line));
if ( ncig+iref > stats->nrseq_buf )
error("FIXME: %d+%d > %d, %s, %s:%d\n",ncig,iref,stats->nrseq_buf, bam_get_qname(bam_line),stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1);
int im;
for (im=0; im<ncig; im++)
{
uint8_t cread = bam_seqi(read,iread);
uint8_t cref = stats->rseq_buf[iref];
// ---------------15
// =ACMGRSVTWYHKDBN
if ( cread==15 )
{
int idx = is_fwd ? icycle : read_len-icycle-1;
if ( idx>stats->max_len )
error("mpc: %d>%d\n",idx,stats->max_len);
idx = idx*stats->nquals;
if ( idx>=stats->nquals*stats->nbases )
error("FIXME: mpc_buf overflow\n");
mpc_buf[idx]++;
}
else if ( cref && cread && cref!=cread )
{
uint8_t qual = quals[iread] + 1;
if ( qual>=stats->nquals )
error("TODO: quality too high %d>=%d (%s %d %s)\n", qual,stats->nquals, stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1,bam_get_qname(bam_line));
int idx = is_fwd ? icycle : read_len-icycle-1;
if ( idx>stats->max_len )
error("mpc: %d>%d (%s %d %s)\n",idx,stats->max_len,stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1,bam_get_qname(bam_line));
idx = idx*stats->nquals + qual;
if ( idx>=stats->nquals*stats->nbases )
error("FIXME: mpc_buf overflow\n");
mpc_buf[idx]++;
}
iref++;
iread++;
icycle++;
}
}
}
void read_ref_seq(stats_t *stats, int32_t tid, int32_t pos)
{
int i, fai_ref_len;
char *fai_ref = faidx_fetch_seq(stats->fai, stats->sam_header->target_name[tid], pos, pos+stats->mrseq_buf-1, &fai_ref_len);
if ( fai_ref_len<0 ) error("Failed to fetch the sequence \"%s\"\n", stats->sam_header->target_name[tid]);
uint8_t *ptr = stats->rseq_buf;
for (i=0; i<fai_ref_len; i++)
{
// Conversion between uint8_t coding and ACGT
// -12-4---8-------
// =ACMGRSVTWYHKDBN
switch (fai_ref[i])
{
case 'A':
case 'a': *ptr = 1; break;
case 'C':
case 'c': *ptr = 2; break;
case 'G':
case 'g': *ptr = 4; break;
case 'T':
case 't': *ptr = 8; break;
default: *ptr = 0; break;
}
ptr++;
}
free(fai_ref);
if ( fai_ref_len < stats->mrseq_buf ) memset(ptr,0, stats->mrseq_buf - fai_ref_len);
stats->nrseq_buf = fai_ref_len;
stats->rseq_pos = pos;
stats->tid = tid;
}
float fai_gc_content(stats_t *stats, int pos, int len)
{
uint32_t gc,count,c;
int i = pos - stats->rseq_pos, ito = i + len;
assert( i>=0 );
if ( ito > stats->nrseq_buf ) ito = stats->nrseq_buf;
// Count GC content
gc = count = 0;
for (; i<ito; i++)
{
c = stats->rseq_buf[i];
if ( c==2 || c==4 )
{
gc++;
count++;
}
else if ( c==1 || c==8 )
count++;
}
return count ? (float)gc/count : 0;
}
void realloc_rseq_buffer(stats_t *stats)
{
int n = stats->nbases*10;
if ( stats->gcd_bin_size > n ) n = stats->gcd_bin_size;
if ( stats->mrseq_buf<n )
{
stats->rseq_buf = realloc(stats->rseq_buf,sizeof(uint8_t)*n);
stats->mrseq_buf = n;
}
}
void realloc_gcd_buffer(stats_t *stats, int seq_len)
{
hts_expand0(gc_depth_t,stats->igcd+1,stats->ngcd,stats->gcd);
realloc_rseq_buffer(stats);
}
void realloc_buffers(stats_t *stats, int seq_len)
{
int n = 2*(1 + seq_len - stats->nbases) + stats->nbases;
stats->quals_1st = realloc(stats->quals_1st, n*stats->nquals*sizeof(uint64_t));
if ( !stats->quals_1st )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*stats->nquals*sizeof(uint64_t));
memset(stats->quals_1st + stats->nbases*stats->nquals, 0, (n-stats->nbases)*stats->nquals*sizeof(uint64_t));
stats->quals_2nd = realloc(stats->quals_2nd, n*stats->nquals*sizeof(uint64_t));
if ( !stats->quals_2nd )
error("Could not realloc buffers, the sequence too long: %d (2x%ld)\n", seq_len,n*stats->nquals*sizeof(uint64_t));
memset(stats->quals_2nd + stats->nbases*stats->nquals, 0, (n-stats->nbases)*stats->nquals*sizeof(uint64_t));
if ( stats->mpc_buf )
{
stats->mpc_buf = realloc(stats->mpc_buf, n*stats->nquals*sizeof(uint64_t));
if ( !stats->mpc_buf )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*stats->nquals*sizeof(uint64_t));
memset(stats->mpc_buf + stats->nbases*stats->nquals, 0, (n-stats->nbases)*stats->nquals*sizeof(uint64_t));
}
stats->acgt_cycles = realloc(stats->acgt_cycles, n*4*sizeof(uint64_t));
if ( !stats->acgt_cycles )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*4*sizeof(uint64_t));
memset(stats->acgt_cycles + stats->nbases*4, 0, (n-stats->nbases)*4*sizeof(uint64_t));
stats->read_lengths = realloc(stats->read_lengths, n*sizeof(uint64_t));
if ( !stats->read_lengths )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*sizeof(uint64_t));
memset(stats->read_lengths + stats->nbases, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->insertions = realloc(stats->insertions, n*sizeof(uint64_t));
if ( !stats->insertions )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*sizeof(uint64_t));
memset(stats->insertions + stats->nbases, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->deletions = realloc(stats->deletions, n*sizeof(uint64_t));
if ( !stats->deletions )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,n*sizeof(uint64_t));
memset(stats->deletions + stats->nbases, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->ins_cycles_1st = realloc(stats->ins_cycles_1st, (n+1)*sizeof(uint64_t));
if ( !stats->ins_cycles_1st )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,(n+1)*sizeof(uint64_t));
memset(stats->ins_cycles_1st + stats->nbases + 1, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->ins_cycles_2nd = realloc(stats->ins_cycles_2nd, (n+1)*sizeof(uint64_t));
if ( !stats->ins_cycles_2nd )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,(n+1)*sizeof(uint64_t));
memset(stats->ins_cycles_2nd + stats->nbases + 1, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->del_cycles_1st = realloc(stats->del_cycles_1st, (n+1)*sizeof(uint64_t));
if ( !stats->del_cycles_1st )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,(n+1)*sizeof(uint64_t));
memset(stats->del_cycles_1st + stats->nbases + 1, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->del_cycles_2nd = realloc(stats->del_cycles_2nd, (n+1)*sizeof(uint64_t));
if ( !stats->del_cycles_2nd )
error("Could not realloc buffers, the sequence too long: %d (%ld)\n", seq_len,(n+1)*sizeof(uint64_t));
memset(stats->del_cycles_2nd + stats->nbases + 1, 0, (n-stats->nbases)*sizeof(uint64_t));
stats->nbases = n;
// Realloc the coverage distribution buffer
int *rbuffer = calloc(sizeof(int),seq_len*5);
n = stats->cov_rbuf.size-stats->cov_rbuf.start;
memcpy(rbuffer,stats->cov_rbuf.buffer+stats->cov_rbuf.start,n);
if ( stats->cov_rbuf.start>1 )
memcpy(rbuffer+n,stats->cov_rbuf.buffer,stats->cov_rbuf.start);
stats->cov_rbuf.start = 0;
free(stats->cov_rbuf.buffer);
stats->cov_rbuf.buffer = rbuffer;
stats->cov_rbuf.size = seq_len*5;
realloc_rseq_buffer(stats);
}
void update_checksum(bam1_t *bam_line, stats_t *stats)
{
uint8_t *name = (uint8_t*) bam_get_qname(bam_line);
int len = 0;
while ( name[len] ) len++;
stats->checksum.names += crc32(0L, name, len);
int seq_len = bam_line->core.l_qseq;
if ( !seq_len ) return;
uint8_t *seq = bam_get_seq(bam_line);
stats->checksum.reads += crc32(0L, seq, (seq_len+1)/2);
uint8_t *qual = bam_get_qual(bam_line);
stats->checksum.quals += crc32(0L, qual, (seq_len+1)/2);
}
void collect_stats(bam1_t *bam_line, stats_t *stats)
{
if ( stats->rg_hash )
{
const uint8_t *rg = bam_aux_get(bam_line, "RG");
if ( !rg ) return; // certain read groups were requested but this record has none
if ( !khash_str2int_has_key(stats->rg_hash, (const char*)(rg + 1)) ) return;
}
if ( stats->flag_require && (bam_line->core.flag & stats->flag_require)!=stats->flag_require )
{
stats->nreads_filtered++;
return;
}
if ( stats->flag_filter && (bam_line->core.flag & stats->flag_filter) )
{
stats->nreads_filtered++;
return;
}
if ( !is_in_regions(bam_line,stats) )
return;
if ( stats->filter_readlen!=-1 && bam_line->core.l_qseq!=stats->filter_readlen )
return;
if ( bam_line->core.flag & BAM_FQCFAIL ) stats->nreads_QCfailed++;
if ( bam_line->core.flag & BAM_FSECONDARY ) stats->nreads_secondary++;
if ( bam_line->core.flag & BAM_FPAIRED ) stats->nreads_paired_tech++;
update_checksum(bam_line, stats);
int seq_len = bam_line->core.l_qseq;
if ( !seq_len ) return;
int read_len = unclipped_length(bam_line);
if ( read_len >= stats->nbases )
realloc_buffers(stats,read_len);
if ( stats->max_len<read_len )
stats->max_len = read_len;
stats->read_lengths[read_len]++;
// Count GC and ACGT per cycle. Note that cycle is approximate, clipping is ignored
uint8_t base, *seq = bam_get_seq(bam_line);
int gc_count = 0;
int i;
int reverse = IS_REVERSE(bam_line);
for (i=0; i<seq_len; i++)
{
// Conversion from uint8_t coding to ACGT
// -12-4---8------5
// =ACMGRSVTWYHKDBN
// 01 2 3
base = bam_seqi(seq,i);
if ( base==0 ) break; // not ready for "=" sequences
base /= 2;
if ( base==1 || base==2 ) gc_count++;
else if ( base>2 ) base=3;
if ( 4*(reverse ? seq_len-i-1 : i) + base >= stats->nbases*4 )
error("FIXME: acgt_cycles\n");
stats->acgt_cycles[ 4*(reverse ? seq_len-i-1 : i) + base ]++;
}
int gc_idx_min = gc_count*(stats->ngc-1)/seq_len;
int gc_idx_max = (gc_count+1)*(stats->ngc-1)/seq_len;
if ( gc_idx_max >= stats->ngc ) gc_idx_max = stats->ngc - 1;
// Determine which array (1st or 2nd read) will these stats go to,
// trim low quality bases from end the same way BWA does,
// fill GC histogram
uint64_t *quals;
uint8_t *bam_quals = bam_get_qual(bam_line);
if ( bam_line->core.flag&BAM_FREAD2 )
{
quals = stats->quals_2nd;
stats->nreads_2nd++;
for (i=gc_idx_min; i<gc_idx_max; i++)
stats->gc_2nd[i]++;
}
else
{
quals = stats->quals_1st;
stats->nreads_1st++;
for (i=gc_idx_min; i<gc_idx_max; i++)
stats->gc_1st[i]++;
}
if ( stats->trim_qual>0 )
stats->nbases_trimmed += bwa_trim_read(stats->trim_qual, bam_quals, seq_len, reverse);
// Quality histogram and average quality. Clipping is neglected.
for (i=0; i<seq_len; i++)
{
uint8_t qual = bam_quals[ reverse ? seq_len-i-1 : i];
if ( qual>=stats->nquals )
error("TODO: quality too high %d>=%d (%s %d %s)\n", qual,stats->nquals,stats->sam_header->target_name[bam_line->core.tid],bam_line->core.pos+1,bam_get_qname(bam_line));
if ( qual>stats->max_qual )
stats->max_qual = qual;
quals[ i*stats->nquals+qual ]++;
stats->sum_qual += qual;
}
// Look at the flags and increment appropriate counters (mapped, paired, etc)
if ( IS_UNMAPPED(bam_line) )
stats->nreads_unmapped++;
else
{
if ( !bam_line->core.qual )
stats->nreads_mq0++;
count_indels(stats,bam_line);
if ( !IS_PAIRED_AND_MAPPED(bam_line) )
stats->nreads_single_mapped++;
else
{
stats->nreads_paired_and_mapped++;
if (IS_PROPERLYPAIRED(bam_line)) stats->nreads_properly_paired++;
if ( bam_line->core.tid!=bam_line->core.mtid )
stats->nreads_anomalous++;
// The insert size is tricky, because for long inserts the libraries are
// prepared differently and the pairs point in other direction. BWA does
// not set the paired flag for them. Similar thing is true also for 454
// reads. Mates mapped to different chromosomes have isize==0.
int32_t isize = bam_line->core.isize;
if ( isize<0 ) isize = -isize;
if ( stats->nisize > 0 && isize >= stats->nisize )
isize = stats->nisize-1;
if ( isize>0 || bam_line->core.tid==bam_line->core.mtid )
{
int pos_fst = bam_line->core.mpos - bam_line->core.pos;
int is_fst = IS_READ1(bam_line) ? 1 : -1;
int is_fwd = IS_REVERSE(bam_line) ? -1 : 1;
int is_mfwd = IS_MATE_REVERSE(bam_line) ? -1 : 1;
if ( is_fwd*is_mfwd>0 )
stats->isize->inc_other(stats->isize->data, isize);
else if ( is_fst*pos_fst>0 )
{
if ( is_fst*is_fwd>0 )
stats->isize->inc_inward(stats->isize->data, isize);
else
stats->isize->inc_outward(stats->isize->data, isize);
}
else if ( is_fst*pos_fst<0 )
{
if ( is_fst*is_fwd>0 )
stats->isize->inc_outward(stats->isize->data, isize);
else
stats->isize->inc_inward(stats->isize->data, isize);
}
}
}
// Number of mismatches
uint8_t *nm = bam_aux_get(bam_line,"NM");
if (nm)
stats->nmismatches += bam_aux2i(nm);
// Number of mapped bases from cigar
if ( bam_line->core.n_cigar == 0)
error("FIXME: mapped read with no cigar?\n");
int readlen=seq_len;
if ( stats->regions )
{
// Count only on-target bases
int iref = bam_line->core.pos + 1;
for (i=0; i<bam_line->core.n_cigar; i++)
{
int cig = bam_cigar_op(bam_get_cigar(bam_line)[i]);
int ncig = bam_cigar_oplen(bam_get_cigar(bam_line)[i]);
if ( !ncig ) continue; // curiously, this can happen: 0D
if ( cig==BAM_CDEL ) readlen += ncig;
else if ( cig==BAM_CMATCH )
{
if ( iref < stats->reg_from ) ncig -= stats->reg_from-iref;
else if ( iref+ncig-1 > stats->reg_to ) ncig -= iref+ncig-1 - stats->reg_to;
if ( ncig<0 ) ncig = 0;
stats->nbases_mapped_cigar += ncig;
iref += bam_cigar_oplen(bam_get_cigar(bam_line)[i]);
}
else if ( cig==BAM_CINS )
{
iref += ncig;
if ( iref>=stats->reg_from && iref<=stats->reg_to )
stats->nbases_mapped_cigar += ncig;
}
}
}
else
{
// Count the whole read
for (i=0; i<bam_line->core.n_cigar; i++)
{
if ( bam_cigar_op(bam_get_cigar(bam_line)[i])==BAM_CMATCH || bam_cigar_op(bam_get_cigar(bam_line)[i])==BAM_CINS )
stats->nbases_mapped_cigar += bam_cigar_oplen(bam_get_cigar(bam_line)[i]);
if ( bam_cigar_op(bam_get_cigar(bam_line)[i])==BAM_CDEL )
readlen += bam_cigar_oplen(bam_get_cigar(bam_line)[i]);
}
}
stats->nbases_mapped += seq_len;
if ( stats->tid==bam_line->core.tid && bam_line->core.pos<stats->pos )
stats->is_sorted = 0;
stats->pos = bam_line->core.pos;
if ( stats->is_sorted )
{
if ( stats->tid==-1 || stats->tid!=bam_line->core.tid )
round_buffer_flush(stats,-1);
// Mismatches per cycle and GC-depth graph. For simplicity, reads overlapping GCD bins
// are not splitted which results in up to seq_len-1 overlaps. The default bin size is
// 20kbp, so the effect is negligible.
if ( stats->fai )
{
int inc_ref = 0, inc_gcd = 0;
// First pass or new chromosome
if ( stats->rseq_pos==-1 || stats->tid != bam_line->core.tid ) { inc_ref=1; inc_gcd=1; }
// Read goes beyond the end of the rseq buffer
else if ( stats->rseq_pos+stats->nrseq_buf < bam_line->core.pos+readlen ) { inc_ref=1; inc_gcd=1; }
// Read overlaps the next gcd bin
else if ( stats->gcd_pos+stats->gcd_bin_size < bam_line->core.pos+readlen )
{
inc_gcd = 1;
if ( stats->rseq_pos+stats->nrseq_buf < bam_line->core.pos+stats->gcd_bin_size ) inc_ref = 1;
}
if ( inc_gcd )
{
stats->igcd++;
if ( stats->igcd >= stats->ngcd )
realloc_gcd_buffer(stats, readlen);
if ( inc_ref )
read_ref_seq(stats,bam_line->core.tid,bam_line->core.pos);
stats->gcd_pos = bam_line->core.pos;
stats->gcd[ stats->igcd ].gc = fai_gc_content(stats, stats->gcd_pos, stats->gcd_bin_size);
}
count_mismatches_per_cycle(stats,bam_line,read_len);
}
// No reference and first pass, new chromosome or sequence going beyond the end of the gcd bin
else if ( stats->gcd_pos==-1 || stats->tid != bam_line->core.tid || bam_line->core.pos - stats->gcd_pos > stats->gcd_bin_size )
{
// First pass or a new chromosome
stats->tid = bam_line->core.tid;
stats->gcd_pos = bam_line->core.pos;
stats->igcd++;
if ( stats->igcd >= stats->ngcd )
realloc_gcd_buffer(stats, readlen);
}
stats->gcd[ stats->igcd ].depth++;
// When no reference sequence is given, approximate the GC from the read (much shorter window, but otherwise OK)
if ( !stats->fai )
stats->gcd[ stats->igcd ].gc += (float) gc_count / seq_len;
// Coverage distribution graph
round_buffer_flush(stats,bam_line->core.pos);
round_buffer_insert_read(&(stats->cov_rbuf),bam_line->core.pos,bam_line->core.pos+seq_len-1);
}
}
stats->total_len += seq_len;
if ( IS_DUP(bam_line) )
{
stats->total_len_dup += seq_len;
stats->nreads_dup++;
}
}
// Sort by GC and depth
#define GCD_t(x) ((gc_depth_t *)x)
static int gcd_cmp(const void *a, const void *b)
{
if ( GCD_t(a)->gc < GCD_t(b)->gc ) return -1;
if ( GCD_t(a)->gc > GCD_t(b)->gc ) return 1;
if ( GCD_t(a)->depth < GCD_t(b)->depth ) return -1;
if ( GCD_t(a)->depth > GCD_t(b)->depth ) return 1;
return 0;
}
#undef GCD_t
float gcd_percentile(gc_depth_t *gcd, int N, int p)
{
float n,d;
int k;
n = p*(N+1)/100;
k = n;
if ( k<=0 )
return gcd[0].depth;
if ( k>=N )
return gcd[N-1].depth;
d = n - k;
return gcd[k-1].depth + d*(gcd[k].depth - gcd[k-1].depth);
}
void output_stats(stats_t *stats, int sparse)
{
// Calculate average insert size and standard deviation (from the main bulk data only)
int isize, ibulk=0;
uint64_t nisize=0, nisize_inward=0, nisize_outward=0, nisize_other=0;
for (isize=0; isize<stats->isize->nitems(stats->isize->data); isize++)
{
// Each pair was counted twice
stats->isize->set_inward(stats->isize->data, isize, stats->isize->inward(stats->isize->data, isize) * 0.5);
stats->isize->set_outward(stats->isize->data, isize, stats->isize->outward(stats->isize->data, isize) * 0.5);
stats->isize->set_other(stats->isize->data, isize, stats->isize->other(stats->isize->data, isize) * 0.5);
nisize_inward += stats->isize->inward(stats->isize->data, isize);
nisize_outward += stats->isize->outward(stats->isize->data, isize);
nisize_other += stats->isize->other(stats->isize->data, isize);
nisize += stats->isize->inward(stats->isize->data, isize) + stats->isize->outward(stats->isize->data, isize) + stats->isize->other(stats->isize->data, isize);
}
double bulk=0, avg_isize=0, sd_isize=0;
for (isize=0; isize<stats->isize->nitems(stats->isize->data); isize++)
{
bulk += stats->isize->inward(stats->isize->data, isize) + stats->isize->outward(stats->isize->data, isize) + stats->isize->other(stats->isize->data, isize);
avg_isize += isize * (stats->isize->inward(stats->isize->data, isize) + stats->isize->outward(stats->isize->data, isize) + stats->isize->other(stats->isize->data, isize));
if ( bulk/nisize > stats->isize_main_bulk )
{
ibulk = isize+1;
nisize = bulk;
break;
}
}
avg_isize /= nisize ? nisize : 1;
for (isize=1; isize<ibulk; isize++)
sd_isize += (stats->isize->inward(stats->isize->data, isize) + stats->isize->outward(stats->isize->data, isize) +stats->isize->other(stats->isize->data, isize)) * (isize-avg_isize)*(isize-avg_isize) / nisize;
sd_isize = sqrt(sd_isize);
printf("# This file was produced by samtools stats (%s+htslib-%s) and can be plotted using plot-bamstats\n", samtools_version(), hts_version());
printf("# The command line was: %s",stats->argv[0]);
int i;
for (i=1; i<stats->argc; i++)
printf(" %s",stats->argv[i]);
printf("\n");
printf("# CHK, Checksum\t[2]Read Names\t[3]Sequences\t[4]Qualities\n");
printf("# CHK, CRC32 of reads which passed filtering followed by addition (32bit overflow)\n");
printf("CHK\t%08x\t%08x\t%08x\n", stats->checksum.names,stats->checksum.reads,stats->checksum.quals);
printf("# Summary Numbers. Use `grep ^SN | cut -f 2-` to extract this part.\n");
printf("SN\traw total sequences:\t%ld\n", (long)(stats->nreads_filtered+stats->nreads_1st+stats->nreads_2nd)); // not counting excluded seqs (and none of the below)
printf("SN\tfiltered sequences:\t%ld\n", (long)stats->nreads_filtered);
printf("SN\tsequences:\t%ld\n", (long)(stats->nreads_1st+stats->nreads_2nd));
printf("SN\tis sorted:\t%d\n", stats->is_sorted ? 1 : 0);
printf("SN\t1st fragments:\t%ld\n", (long)stats->nreads_1st);
printf("SN\tlast fragments:\t%ld\n", (long)stats->nreads_2nd);
printf("SN\treads mapped:\t%ld\n", (long)(stats->nreads_paired_and_mapped+stats->nreads_single_mapped));
printf("SN\treads mapped and paired:\t%ld\t# paired-end technology bit set + both mates mapped\n", (long)stats->nreads_paired_and_mapped);
printf("SN\treads unmapped:\t%ld\n", (long)stats->nreads_unmapped);
printf("SN\treads properly paired:\t%ld\t# proper-pair bit set\n", (long)stats->nreads_properly_paired);
printf("SN\treads paired:\t%ld\t# paired-end technology bit set\n", (long)stats->nreads_paired_tech);
printf("SN\treads duplicated:\t%ld\t# PCR or optical duplicate bit set\n", (long)stats->nreads_dup);
printf("SN\treads MQ0:\t%ld\t# mapped and MQ=0\n", (long)stats->nreads_mq0);
printf("SN\treads QC failed:\t%ld\n", (long)stats->nreads_QCfailed);
printf("SN\tnon-primary alignments:\t%ld\n", (long)stats->nreads_secondary);
printf("SN\ttotal length:\t%ld\t# ignores clipping\n", (long)stats->total_len);
printf("SN\tbases mapped:\t%ld\t# ignores clipping\n", (long)stats->nbases_mapped); // the length of the whole read goes here, including soft-clips etc.
printf("SN\tbases mapped (cigar):\t%ld\t# more accurate\n", (long)stats->nbases_mapped_cigar); // only matched and inserted bases are counted here
printf("SN\tbases trimmed:\t%ld\n", (long)stats->nbases_trimmed);
printf("SN\tbases duplicated:\t%ld\n", (long)stats->total_len_dup);
printf("SN\tmismatches:\t%ld\t# from NM fields\n", (long)stats->nmismatches);
printf("SN\terror rate:\t%e\t# mismatches / bases mapped (cigar)\n", stats->nbases_mapped_cigar ? (float)stats->nmismatches/stats->nbases_mapped_cigar : 0);
float avg_read_length = (stats->nreads_1st+stats->nreads_2nd)?stats->total_len/(stats->nreads_1st+stats->nreads_2nd):0;
printf("SN\taverage length:\t%.0f\n", avg_read_length);
printf("SN\tmaximum length:\t%d\n", stats->max_len);
printf("SN\taverage quality:\t%.1f\n", stats->total_len?stats->sum_qual/stats->total_len:0);
printf("SN\tinsert size average:\t%.1f\n", avg_isize);
printf("SN\tinsert size standard deviation:\t%.1f\n", sd_isize);
printf("SN\tinward oriented pairs:\t%ld\n", (long)nisize_inward);
printf("SN\toutward oriented pairs:\t%ld\n", (long)nisize_outward);
printf("SN\tpairs with other orientation:\t%ld\n", (long)nisize_other);
printf("SN\tpairs on different chromosomes:\t%ld\n", (long)stats->nreads_anomalous/2);
int ibase,iqual;
if ( stats->max_len<stats->nbases ) stats->max_len++;
if ( stats->max_qual+1<stats->nquals ) stats->max_qual++;
printf("# First Fragment Qualitites. Use `grep ^FFQ | cut -f 2-` to extract this part.\n");
printf("# Columns correspond to qualities and rows to cycles. First column is the cycle number.\n");
for (ibase=0; ibase<stats->max_len; ibase++)
{
printf("FFQ\t%d",ibase+1);
for (iqual=0; iqual<=stats->max_qual; iqual++)
{