]> git.donarmstrong.com Git - samtools.git/blob - bcftools/call1.c
Fixed the VCF header to pass validation
[samtools.git] / bcftools / call1.c
1 #include <unistd.h>
2 #include <stdlib.h>
3 #include <math.h>
4 #include <zlib.h>
5 #include <errno.h>
6 #include "bcf.h"
7 #include "prob1.h"
8 #include "kstring.h"
9
10 #include "khash.h"
11 KHASH_SET_INIT_INT64(set64)
12
13 #include "kseq.h"
14 KSTREAM_INIT(gzFile, gzread, 16384)
15
16 #define VC_NO_GENO 2
17 #define VC_BCFOUT  4
18 #define VC_CALL    8
19 #define VC_VARONLY 16
20 #define VC_VCFIN   32
21 #define VC_UNCOMP  64
22 #define VC_HWE     128
23 #define VC_KEEPALT 256
24 #define VC_ACGT_ONLY 512
25 #define VC_QCALL   1024
26 #define VC_CALL_GT 2048
27 #define VC_ADJLD   4096
28 #define VC_NO_INDEL 8192
29 #define VC_ANNO_MAX 16384
30
31 typedef struct {
32         int flag, prior_type, n1;
33         char *fn_list, *prior_file;
34         double theta, pref, indel_frac;
35 } viewconf_t;
36
37 khash_t(set64) *bcf_load_pos(const char *fn, bcf_hdr_t *_h)
38 {
39         void *str2id;
40         gzFile fp;
41         kstream_t *ks;
42         int ret, dret, lineno = 1;
43         kstring_t *str;
44         khash_t(set64) *hash = 0;
45
46         hash = kh_init(set64);
47         str2id = bcf_build_refhash(_h);
48         str = calloc(1, sizeof(kstring_t));
49         fp = strcmp(fn, "-")? gzopen(fn, "r") : gzdopen(fileno(stdin), "r");
50         ks = ks_init(fp);
51         while (ks_getuntil(ks, 0, str, &dret) >= 0) {
52                 int tid = bcf_str2id(str2id, str->s);
53                 if (tid >= 0 && dret != '\n') {
54                         if (ks_getuntil(ks, 0, str, &dret) >= 0) {
55                                 uint64_t x = (uint64_t)tid<<32 | (atoi(str->s) - 1);
56                                 kh_put(set64, hash, x, &ret);
57                         } else break;
58                 } else fprintf(stderr, "[%s] %s is not a reference name (line %d).\n", __func__, str->s, lineno);
59                 if (dret != '\n') while ((dret = ks_getc(ks)) > 0 && dret != '\n');
60                 if (dret < 0) break;
61                 ++lineno;
62         }
63         bcf_str2id_destroy(str2id);
64         ks_destroy(ks);
65         gzclose(fp);
66         free(str->s); free(str);
67         return hash;
68 }
69
70 static double test_hwe(const double g[3])
71 {
72         extern double kf_gammaq(double p, double x);
73         double fexp, chi2, f[3], n;
74         int i;
75         n = g[0] + g[1] + g[2];
76         fexp = (2. * g[2] + g[1]) / (2. * n);
77         if (fexp > 1. - 1e-10) fexp = 1. - 1e-10;
78         if (fexp < 1e-10) fexp = 1e-10;
79         f[0] = n * (1. - fexp) * (1. - fexp);
80         f[1] = n * 2. * fexp * (1. - fexp);
81         f[2] = n * fexp * fexp;
82         for (i = 0, chi2 = 0.; i < 3; ++i)
83                 chi2 += (g[i] - f[i]) * (g[i] - f[i]) / f[i];
84         return kf_gammaq(.5, chi2 / 2.);
85 }
86
87 typedef struct {
88         double p[4];
89         int mq, depth, is_tested, d[4];
90 } anno16_t;
91
92 static double ttest(int n1, int n2, int a[4])
93 {
94         extern double kf_betai(double a, double b, double x);
95         double t, v, u1, u2;
96         if (n1 == 0 || n2 == 0 || n1 + n2 < 3) return 1.0;
97         u1 = (double)a[0] / n1; u2 = (double)a[2] / n2;
98         if (u1 <= u2) return 1.;
99         t = (u1 - u2) / sqrt(((a[1] - n1 * u1 * u1) + (a[3] - n2 * u2 * u2)) / (n1 + n2 - 2) * (1./n1 + 1./n2));
100         v = n1 + n2 - 2;
101 //      printf("%d,%d,%d,%d,%lf,%lf,%lf\n", a[0], a[1], a[2], a[3], t, u1, u2);
102         return t < 0.? 1. : .5 * kf_betai(.5*v, .5, v/(v+t*t));
103 }
104
105 static int test16_core(int anno[16], anno16_t *a)
106 {
107         extern double kt_fisher_exact(int n11, int n12, int n21, int n22, double *_left, double *_right, double *two);
108         double left, right;
109         int i;
110         a->p[0] = a->p[1] = a->p[2] = a->p[3] = 1.;
111         memcpy(a->d, anno, 4 * sizeof(int));
112         a->depth = anno[0] + anno[1] + anno[2] + anno[3];
113         a->is_tested = (anno[0] + anno[1] > 0 && anno[2] + anno[3] > 0);
114         if (a->depth == 0) return -1;
115         a->mq = (int)(sqrt((anno[9] + anno[11]) / a->depth) + .499);
116         kt_fisher_exact(anno[0], anno[1], anno[2], anno[3], &left, &right, &a->p[0]);
117         for (i = 1; i < 4; ++i)
118                 a->p[i] = ttest(anno[0] + anno[1], anno[2] + anno[3], anno+4*i);
119         return 0;
120 }
121
122 static int test16(bcf1_t *b, anno16_t *a)
123 {
124         char *p;
125         int i, anno[16];
126         a->p[0] = a->p[1] = a->p[2] = a->p[3] = 1.;
127         a->d[0] = a->d[1] = a->d[2] = a->d[3] = 0.;
128         a->mq = a->depth = a->is_tested = 0;
129         if ((p = strstr(b->info, "I16=")) == 0) return -1;
130         p += 4;
131         for (i = 0; i < 16; ++i) {
132                 errno = 0; anno[i] = strtol(p, &p, 10);
133                 if (anno[i] == 0 && (errno == EINVAL || errno == ERANGE)) return -2;
134                 ++p;
135         }
136         return test16_core(anno, a);
137 }
138
139 static void rm_info(bcf1_t *b, const char *key)
140 {
141         char *p, *q;
142         if ((p = strstr(b->info, key)) == 0) return;
143         for (q = p; *q && *q != ';'; ++q);
144         if (p > b->info && *(p-1) == ';') --p;
145         memmove(p, q, b->l_str - (q - b->str));
146         b->l_str -= q - p;
147         bcf_sync(b);
148 }
149
150 static int update_bcf1(int n_smpl, bcf1_t *b, const bcf_p1aux_t *pa, const bcf_p1rst_t *pr, double pref, int flag)
151 {
152         kstring_t s;
153         int is_var = (pr->p_ref < pref);
154         double p_hwe, r = is_var? pr->p_ref : pr->p_var, fq;
155         anno16_t a;
156
157         p_hwe = pr->g[0] >= 0.? test_hwe(pr->g) : 1.0; // only do HWE g[] is calculated
158         test16(b, &a);
159         rm_info(b, "I16=");
160
161         memset(&s, 0, sizeof(kstring_t));
162         kputc('\0', &s); kputs(b->ref, &s); kputc('\0', &s);
163         kputs(b->alt, &s); kputc('\0', &s); kputc('\0', &s);
164         kputs(b->info, &s);
165         if (b->info[0]) kputc(';', &s);
166 //      ksprintf(&s, "AF1=%.4lg;AFE=%.4lg;CI95=%.4lg,%.4lg", 1.-pr->f_em, 1.-pr->f_exp, pr->cil, pr->cih);
167         ksprintf(&s, "AF1=%.4g;CI95=%.4g,%.4g", 1.-pr->f_em, pr->cil, pr->cih);
168         ksprintf(&s, ";DP4=%d,%d,%d,%d;MQ=%d", a.d[0], a.d[1], a.d[2], a.d[3], a.mq);
169         fq = pr->p_ref_folded < 0.5? -4.343 * log(pr->p_ref_folded) : 4.343 * log(pr->p_var_folded);
170         if (fq < -999) fq = -999;
171         if (fq > 999) fq = 999;
172         ksprintf(&s, ";FQ=%.3g", fq);
173         if (a.is_tested) {
174                 if (pr->pc[0] >= 0.) ksprintf(&s, ";PC4=%g,%g,%g,%g", pr->pc[0], pr->pc[1], pr->pc[2], pr->pc[3]);
175                 ksprintf(&s, ";PV4=%.2g,%.2g,%.2g,%.2g", a.p[0], a.p[1], a.p[2], a.p[3]);
176         }
177         if (pr->g[0] >= 0. && p_hwe <= .2)
178                 ksprintf(&s, ";GC=%.2f,%.2f,%.2f;HWE=%.3f", pr->g[2], pr->g[1], pr->g[0], p_hwe);
179         kputc('\0', &s);
180         kputs(b->fmt, &s); kputc('\0', &s);
181         free(b->str);
182         b->m_str = s.m; b->l_str = s.l; b->str = s.s;
183         b->qual = r < 1e-100? 999 : -4.343 * log(r);
184         if (b->qual > 999) b->qual = 999;
185         bcf_sync(b);
186         if (!is_var) bcf_shrink_alt(b, 1);
187         else if (!(flag&VC_KEEPALT))
188                 bcf_shrink_alt(b, pr->rank0 < 2? 2 : pr->rank0+1);
189         if (is_var && (flag&VC_CALL_GT)) { // call individual genotype
190                 int i, x, old_n_gi = b->n_gi;
191                 s.m = b->m_str; s.l = b->l_str - 1; s.s = b->str;
192                 kputs(":GT:GQ", &s); kputc('\0', &s);
193                 b->m_str = s.m; b->l_str = s.l; b->str = s.s;
194                 bcf_sync(b);
195                 for (i = 0; i < b->n_smpl; ++i) {
196                         x = bcf_p1_call_gt(pa, pr->f_em, i);
197                         ((uint8_t*)b->gi[old_n_gi].data)[i] = (x&3) == 0? 1<<3|1 : (x&3) == 1? 1 : 0;
198                         ((uint8_t*)b->gi[old_n_gi+1].data)[i] = x>>2;
199                 }
200         }
201         return is_var;
202 }
203
204 static void write_header(bcf_hdr_t *h)
205 {
206         kstring_t str;
207         str.l = h->l_txt? h->l_txt - 1 : 0;
208         str.m = str.l + 1; str.s = h->txt;
209         if (!strstr(str.s, "##INFO=<ID=DP,"))
210                 kputs("##INFO=<ID=DP,Number=1,Type=Integer,Description=\"Raw read depth\">\n", &str);
211         if (!strstr(str.s, "##INFO=<ID=DP4,"))
212                 kputs("##INFO=<ID=DP4,Number=4,Type=Integer,Description=\"# high-quality ref-forward bases, ref-reverse, alt-forward and alt-reverse bases\">\n", &str);
213         if (!strstr(str.s, "##INFO=<ID=MQ,"))
214                 kputs("##INFO=<ID=MQ,Number=1,Type=Integer,Description=\"Root-mean-square mapping quality of covering reads\">\n", &str);
215         if (!strstr(str.s, "##INFO=<ID=FQ,"))
216                 kputs("##INFO=<ID=FQ,Number=1,Type=Float,Description=\"Phred probability that sample chromosomes are not all the same\">\n", &str);
217         if (!strstr(str.s, "##INFO=<ID=AF1,"))
218                 kputs("##INFO=<ID=AF1,Number=1,Type=Float,Description=\"Max-likelihood estimate of the site allele frequency of the first ALT allele\">\n", &str);
219         if (!strstr(str.s, "##INFO=<ID=CI95,"))
220                 kputs("##INFO=<ID=CI95,Number=2,Type=Float,Description=\"Equal-tail Bayesian credible interval of the site allele frequency at the 95% level\">\n", &str);
221         if (!strstr(str.s, "##INFO=<ID=PV4,"))
222                 kputs("##INFO=<ID=PV4,Number=4,Type=Float,Description=\"P-values for strand bias, baseQ bias, mapQ bias and tail distance bias\">\n", &str);
223     if (!strstr(str.s, "##INFO=<ID=INDEL,"))
224         kputs("##INFO=<ID=INDEL,Number=0,Type=Flag,Descriptin=\"Indicates that the variant is an INDEL.\">\n", &str);
225     if (!strstr(str.s, "##INFO=<ID=GT,"))
226         kputs("##FORMAT=<ID=GT,Number=1,Type=String,Description=\"Genotype\">\n", &str);
227     if (!strstr(str.s, "##FORMAT=<ID=GQ,"))
228         kputs("##FORMAT=<ID=GQ,Number=1,Type=Integer,Description=\"Genotype Quality\">\n", &str);
229     if (!strstr(str.s, "##FORMAT=<ID=GL,"))
230         kputs("##FORMAT=<ID=GL,Number=3,Type=Float,Description=\"Likelihoods for RR,RA,AA genotypes (R=ref,A=alt)\">\n", &str);
231         if (!strstr(str.s, "##FORMAT=<ID=DP,"))
232                 kputs("##FORMAT=<ID=DP,Number=1,Type=Integer,Description=\"# high-quality bases\">\n", &str);
233         if (!strstr(str.s, "##FORMAT=<ID=SP,"))
234                 kputs("##FORMAT=<ID=SP,Number=1,Type=Integer,Description=\"Phred-scaled strand bias P-value\">\n", &str);
235         if (!strstr(str.s, "##FORMAT=<ID=PL,"))
236                 kputs("##FORMAT=<ID=PL,Number=-1,Type=Integer,Description=\"List of Phred-scaled genotype likelihoods, number of values is (#ALT+1)*(#ALT+2)/2\">\n", &str);
237         h->l_txt = str.l + 1; h->txt = str.s;
238 }
239
240 double bcf_ld_freq(const bcf1_t *b0, const bcf1_t *b1, double f[4]);
241
242 int bcfview(int argc, char *argv[])
243 {
244         extern int bcf_2qcall(bcf_hdr_t *h, bcf1_t *b);
245         extern void bcf_p1_indel_prior(bcf_p1aux_t *ma, double x);
246         extern int bcf_fix_gt(bcf1_t *b);
247         extern int bcf_anno_max(bcf1_t *b);
248         bcf_t *bp, *bout = 0;
249         bcf1_t *b, *blast;
250         int c;
251         uint64_t n_processed = 0;
252         viewconf_t vc;
253         bcf_p1aux_t *p1 = 0;
254         bcf_hdr_t *h;
255         int tid, begin, end;
256         char moder[4], modew[4];
257         khash_t(set64) *hash = 0;
258
259         tid = begin = end = -1;
260         memset(&vc, 0, sizeof(viewconf_t));
261         vc.prior_type = vc.n1 = -1; vc.theta = 1e-3; vc.pref = 0.5; vc.indel_frac = -1.;
262         while ((c = getopt(argc, argv, "N1:l:cHAGvbSuP:t:p:QgLi:IM")) >= 0) {
263                 switch (c) {
264                 case '1': vc.n1 = atoi(optarg); break;
265                 case 'l': vc.fn_list = strdup(optarg); break;
266                 case 'N': vc.flag |= VC_ACGT_ONLY; break;
267                 case 'G': vc.flag |= VC_NO_GENO; break;
268                 case 'A': vc.flag |= VC_KEEPALT; break;
269                 case 'b': vc.flag |= VC_BCFOUT; break;
270                 case 'S': vc.flag |= VC_VCFIN; break;
271                 case 'c': vc.flag |= VC_CALL; break;
272                 case 'v': vc.flag |= VC_VARONLY | VC_CALL; break;
273                 case 'u': vc.flag |= VC_UNCOMP | VC_BCFOUT; break;
274                 case 'H': vc.flag |= VC_HWE; break;
275                 case 'g': vc.flag |= VC_CALL_GT | VC_CALL; break;
276                 case 'I': vc.flag |= VC_NO_INDEL; break;
277                 case 'M': vc.flag |= VC_ANNO_MAX; break;
278                 case 't': vc.theta = atof(optarg); break;
279                 case 'p': vc.pref = atof(optarg); break;
280                 case 'i': vc.indel_frac = atof(optarg); break;
281                 case 'Q': vc.flag |= VC_QCALL; break;
282                 case 'L': vc.flag |= VC_ADJLD; break;
283                 case 'P':
284                         if (strcmp(optarg, "full") == 0) vc.prior_type = MC_PTYPE_FULL;
285                         else if (strcmp(optarg, "cond2") == 0) vc.prior_type = MC_PTYPE_COND2;
286                         else if (strcmp(optarg, "flat") == 0) vc.prior_type = MC_PTYPE_FLAT;
287                         else vc.prior_file = strdup(optarg);
288                         break;
289                 }
290         }
291         if (argc == optind) {
292                 fprintf(stderr, "\n");
293                 fprintf(stderr, "Usage:   bcftools view [options] <in.bcf> [reg]\n\n");
294                 fprintf(stderr, "Options: -c        SNP calling\n");
295                 fprintf(stderr, "         -v        output potential variant sites only (force -c)\n");
296                 fprintf(stderr, "         -g        call genotypes at variant sites (force -c)\n");
297                 fprintf(stderr, "         -b        output BCF instead of VCF\n");
298                 fprintf(stderr, "         -u        uncompressed BCF output (force -b)\n");
299                 fprintf(stderr, "         -S        input is VCF\n");
300                 fprintf(stderr, "         -A        keep all possible alternate alleles at variant sites\n");
301                 fprintf(stderr, "         -G        suppress all individual genotype information\n");
302                 fprintf(stderr, "         -H        perform Hardy-Weinberg test (slower)\n");
303                 fprintf(stderr, "         -N        skip sites where REF is not A/C/G/T\n");
304                 fprintf(stderr, "         -Q        output the QCALL likelihood format\n");
305                 fprintf(stderr, "         -L        calculate LD for adjacent sites\n");
306                 fprintf(stderr, "         -I        skip indels\n");
307                 fprintf(stderr, "         -1 INT    number of group-1 samples [0]\n");
308                 fprintf(stderr, "         -l FILE   list of sites to output [all sites]\n");
309                 fprintf(stderr, "         -t FLOAT  scaled substitution mutation rate [%.4g]\n", vc.theta);
310                 fprintf(stderr, "         -i FLOAT  indel-to-substitution ratio [%.4g]\n", vc.indel_frac);
311                 fprintf(stderr, "         -p FLOAT  variant if P(ref|D)<FLOAT [%.3g]\n", vc.pref);
312                 fprintf(stderr, "         -P STR    type of prior: full, cond2, flat [full]\n");
313                 fprintf(stderr, "\n");
314                 return 1;
315         }
316
317         b = calloc(1, sizeof(bcf1_t));
318         blast = calloc(1, sizeof(bcf1_t));
319         strcpy(moder, "r");
320         if (!(vc.flag & VC_VCFIN)) strcat(moder, "b");
321         strcpy(modew, "w");
322         if (vc.flag & VC_BCFOUT) strcat(modew, "b");
323         if (vc.flag & VC_UNCOMP) strcat(modew, "u");
324         bp = vcf_open(argv[optind], moder);
325         h = vcf_hdr_read(bp);
326         bout = vcf_open("-", modew);
327         if (!(vc.flag & VC_QCALL)) {
328                 if (vc.flag & VC_CALL) write_header(h);
329                 vcf_hdr_write(bout, h);
330         }
331         if (vc.flag & VC_CALL) {
332                 p1 = bcf_p1_init(h->n_smpl);
333                 if (vc.prior_file) {
334                         if (bcf_p1_read_prior(p1, vc.prior_file) < 0) {
335                                 fprintf(stderr, "[%s] fail to read the prior AFS.\n", __func__);
336                                 return 1;
337                         }
338                 } else bcf_p1_init_prior(p1, vc.prior_type, vc.theta);
339                 if (vc.n1 > 0) {
340                         bcf_p1_set_n1(p1, vc.n1);
341                         bcf_p1_init_subprior(p1, vc.prior_type, vc.theta);
342                 }
343                 if (vc.indel_frac > 0.) bcf_p1_indel_prior(p1, vc.indel_frac); // otherwise use the default indel_frac
344         }
345         if (vc.fn_list) hash = bcf_load_pos(vc.fn_list, h);
346         if (optind + 1 < argc && !(vc.flag&VC_VCFIN)) {
347                 void *str2id = bcf_build_refhash(h);
348                 if (bcf_parse_region(str2id, argv[optind+1], &tid, &begin, &end) >= 0) {
349                         bcf_idx_t *idx;
350                         idx = bcf_idx_load(argv[optind]);
351                         if (idx) {
352                                 uint64_t off;
353                                 off = bcf_idx_query(idx, tid, begin);
354                                 if (off == 0) {
355                                         fprintf(stderr, "[%s] no records in the query region.\n", __func__);
356                                         return 1; // FIXME: a lot of memory leaks...
357                                 }
358                                 bgzf_seek(bp->fp, off, SEEK_SET);
359                                 bcf_idx_destroy(idx);
360                         }
361                 }
362         }
363         while (vcf_read(bp, h, b) > 0) {
364                 int is_indel = bcf_is_indel(b);
365                 if ((vc.flag & VC_NO_INDEL) && is_indel) continue;
366                 if ((vc.flag & VC_ACGT_ONLY) && !is_indel) {
367                         int x;
368                         if (b->ref[0] == 0 || b->ref[1] != 0) continue;
369                         x = toupper(b->ref[0]);
370                         if (x != 'A' && x != 'C' && x != 'G' && x != 'T') continue;
371                 }
372                 if (hash) {
373                         uint64_t x = (uint64_t)b->tid<<32 | b->pos;
374                         khint_t k = kh_get(set64, hash, x);
375                         if (kh_size(hash) == 0) break;
376                         if (k == kh_end(hash)) continue;
377                         kh_del(set64, hash, k);
378                 }
379                 if (tid >= 0) {
380                         int l = strlen(b->ref);
381                         l = b->pos + (l > 0? l : 1);
382                         if (b->tid != tid || b->pos >= end) break;
383                         if (!(l > begin && end > b->pos)) continue;
384                 }
385                 ++n_processed;
386                 if (vc.flag & VC_QCALL) { // output QCALL format; STOP here
387                         bcf_2qcall(h, b);
388                         continue;
389                 }
390                 if (vc.flag & (VC_CALL|VC_ADJLD)) bcf_gl2pl(b);
391                 if (vc.flag & VC_CALL) { // call variants
392                         bcf_p1rst_t pr;
393                         bcf_p1_cal(b, p1, &pr); // pr.g[3] is not calculated here
394                         if (vc.flag&VC_HWE) bcf_p1_cal_g3(p1, pr.g);
395                         if (n_processed % 100000 == 0) {
396                                 fprintf(stderr, "[%s] %ld sites processed.\n", __func__, (long)n_processed);
397                                 bcf_p1_dump_afs(p1);
398                         }
399                         if (pr.p_ref >= vc.pref && (vc.flag & VC_VARONLY)) continue;
400                         update_bcf1(h->n_smpl, b, p1, &pr, vc.pref, vc.flag);
401                 }
402                 if (vc.flag & VC_ADJLD) { // compute LD
403                         double f[4], r2;
404                         if ((r2 = bcf_ld_freq(blast, b, f)) >= 0) {
405                                 kstring_t s;
406                                 s.m = s.l = 0; s.s = 0;
407                                 if (*b->info) kputc(';', &s);
408                                 ksprintf(&s, "NEIR=%.3f;NEIF=%.3f,%.3f", r2, f[0]+f[2], f[0]+f[1]);
409                                 bcf_append_info(b, s.s, s.l);
410                                 free(s.s);
411                         }
412                         bcf_cpy(blast, b);
413                 }
414                 if (vc.flag & VC_ANNO_MAX) bcf_anno_max(b);
415                 if (vc.flag & VC_NO_GENO) { // do not output GENO fields
416                         b->n_gi = 0;
417                         b->fmt[0] = '\0';
418                         b->l_str = b->fmt - b->str + 1;
419                 } else bcf_fix_gt(b);
420                 vcf_write(bout, h, b);
421         }
422         if (vc.prior_file) free(vc.prior_file);
423         if (vc.flag & VC_CALL) bcf_p1_dump_afs(p1);
424         bcf_hdr_destroy(h);
425         bcf_destroy(b); bcf_destroy(blast);
426         vcf_close(bp); vcf_close(bout);
427         if (hash) kh_destroy(set64, hash);
428         if (vc.fn_list) free(vc.fn_list);
429         if (p1) bcf_p1_destroy(p1);
430         return 0;
431 }