]> git.donarmstrong.com Git - samtools.git/blob - bam_plcmd.c
* output max mapping quality in indel line
[samtools.git] / bam_plcmd.c
1 #include <stdio.h>
2 #include <unistd.h>
3 #include <ctype.h>
4 #include "bam.h"
5 #include "faidx.h"
6 #include "bam_maqcns.h"
7 #include "khash.h"
8 #include "glf.h"
9 KHASH_SET_INIT_INT64(64)
10
11 #define BAM_PLF_SIMPLE     0x01
12 #define BAM_PLF_CNS        0x02
13 #define BAM_PLF_INDEL_ONLY 0x04
14 #define BAM_PLF_GLF        0x08
15
16 typedef struct {
17         bam_header_t *h;
18         bam_maqcns_t *c;
19         bam_maqindel_opt_t *ido;
20         faidx_t *fai;
21         khash_t(64) *hash;
22         uint32_t format;
23         int tid, len;
24         int mask;
25         char *ref;
26         glfFile fp; // for glf output only
27 } pu_data_t;
28
29 char **bam_load_pos(const char *fn, int *_n);
30 void bam_init_header_hash(bam_header_t *header);
31 int32_t bam_get_tid(const bam_header_t *header, const char *seq_name);
32
33 static khash_t(64) *load_pos(const char *fn, bam_header_t *h)
34 {
35         int n, tmp, i;
36         char **list, *s;
37         uint64_t x;
38         khash_t(64) *hash;
39         bam_init_header_hash(h);
40         list = bam_load_pos(fn, &n);
41         hash = kh_init(64);
42         for (i = 0; i < n; ++i) {
43                 x = (uint64_t)bam_get_tid(h, list[i]) << 32;
44                 s = list[i];
45                 while (*s++);
46                 x |= *((uint32_t*)s) - 1;
47                 kh_put(64, hash, x, &tmp);
48                 free(list[i]);
49         }
50         free(list);
51         return hash;
52 }
53
54 // an analogy to pileup_func() below
55 static int glt_func(uint32_t tid, uint32_t pos, int n, const bam_pileup1_t *pu, void *data)
56 {
57         pu_data_t *d = (pu_data_t*)data;
58         bam_maqindel_ret_t *r = 0;
59         int rb;
60         glf1_t *g;
61         glf2_t g2;
62         if (d->fai == 0) {
63                 fprintf(stderr, "[glt_func] reference sequence is required for generating GLT. Abort!\n");
64                 exit(1);
65         }
66         if (d->hash && kh_get(64, d->hash, (uint64_t)tid<<32|pos) == kh_end(d->hash)) return 0;
67         if (d->fai && (int)tid != d->tid) {
68                 if (d->ref) { // then write the end mark
69                         memset(&g2, 0, sizeof(glf2_t));
70                         g2.type = GLF_TYPE_END;
71                         bgzf_write(d->fp, &g2, sizeof(glf2_t));
72                 }
73                 glf_ref_write(d->fp, d->h->target_name[tid]); // write reference
74                 free(d->ref);
75                 d->ref = fai_fetch(d->fai, d->h->target_name[tid], &d->len);
76                 d->tid = tid;
77         }
78         rb = (d->ref && (int)pos < d->len)? d->ref[pos] : 'N';
79         g = bam_maqcns_glfgen(n, pu, bam_nt16_table[rb], d->c);
80         memcpy(&g2, g, sizeof(glf1_t));
81         g2.type = GLF_TYPE_NORMAL;
82         g2.pos = pos;
83         bgzf_write(d->fp, &g2, sizeof(glf2_t));
84         r = bam_maqindel(n, pos, d->ido, pu, d->ref);
85         if (r) { // then write indel line
86                 int g3 = 3 * n, min;
87                 min = g3;
88                 if (min > r->gl[0]) min = r->gl[0];
89                 if (min > r->gl[1]) min = r->gl[1];
90                 g2.ref_base = 0;
91                 g2.type = GLF_TYPE_INDEL;
92                 memset(g2.lk, 0, 10);
93                 g2.lk[0] = r->gl[0] - min < 255? r->gl[0] - min : 255;
94                 g2.lk[1] = r->gl[1] - min < 255? r->gl[1] - min : 255;
95                 g2.lk[2] = g3 - min < 255? g3 - min : 255;
96                 *(int16_t*)(g2.lk + 3) = (int16_t)r->indel1;
97                 *(int16_t*)(g2.lk + 5) = (int16_t)r->indel2;
98                 g2.min_lk = min < 255? min : 255;
99                 bgzf_write(d->fp, &g2, sizeof(glf2_t));
100                 if (r->indel1) bgzf_write(d->fp, r->s[0]+1, r->indel1>0? r->indel1 : -r->indel1);
101                 if (r->indel2) bgzf_write(d->fp, r->s[1]+1, r->indel2>0? r->indel2 : -r->indel2);
102                 bam_maqindel_ret_destroy(r);
103         }
104         free(g);
105         return 0;
106 }
107
108 static int pileup_func(uint32_t tid, uint32_t pos, int n, const bam_pileup1_t *pu, void *data)
109 {
110         pu_data_t *d = (pu_data_t*)data;
111         bam_maqindel_ret_t *r = 0;
112         int i, j, rb, max_mapq = 0;
113         uint32_t x;
114         if (d->hash && kh_get(64, d->hash, (uint64_t)tid<<32|pos) == kh_end(d->hash)) return 0;
115         if (d->format & BAM_PLF_GLF) return glt_func(tid, pos, n, pu, data);
116         if (d->fai && (int)tid != d->tid) {
117                 free(d->ref);
118                 d->ref = fai_fetch(d->fai, d->h->target_name[tid], &d->len);
119                 d->tid = tid;
120         }
121         rb = (d->ref && (int)pos < d->len)? d->ref[pos] : 'N';
122         if (d->format & BAM_PLF_INDEL_ONLY) {
123                 for (i = 0; i < n; ++i)
124                         if (pu[i].indel != 0) break;
125                 if (i == n) return 0;
126         }
127         printf("%s\t%d\t%c\t", d->h->target_name[tid], pos + 1, rb);
128         if (d->format & BAM_PLF_CNS) { // consensus
129                 int ref_q, rb4 = bam_nt16_table[rb];
130                 x = bam_maqcns_call(n, pu, d->c);
131                 ref_q = 0;
132                 if (rb4 != 15 && x>>28 != 15 && x>>28 != rb4) { // a SNP
133                         ref_q = ((x>>24&0xf) == rb4)? x>>8&0xff : (x>>8&0xff) + (x&0xff);
134                         if (ref_q > 255) ref_q = 255;
135                 }
136                 printf("%c\t%d\t%d\t%d\t", bam_nt16_rev_table[x>>28], x>>8&0xff, ref_q, x>>16&0xff);
137         }
138         if (d->format & (BAM_PLF_CNS|BAM_PLF_INDEL_ONLY)) {
139                 if (d->ref) // indel calling
140                         r = bam_maqindel(n, pos, d->ido, pu, d->ref);
141         }
142         // pileup strings
143         printf("%d\t", n);
144         for (i = 0; i < n; ++i) {
145                 const bam_pileup1_t *p = pu + i;
146                 if (max_mapq < p->b->core.qual) max_mapq = p->b->core.qual;
147                 if (p->is_head) printf("^%c", p->b->core.qual > 93? 126 : p->b->core.qual + 33);
148                 if (!p->is_del) {
149                         int c = bam_nt16_rev_table[bam1_seqi(bam1_seq(p->b), p->qpos)];
150                         if (toupper(c) == toupper(rb)) c = bam1_strand(p->b)? ',' : '.';
151                         else bam1_strand(p->b)? tolower(c) : toupper(c);
152                         putchar(c);
153                         if (p->indel > 0) {
154                                 printf("+%d", p->indel);
155                                 for (j = 1; j <= p->indel; ++j) {
156                                         c = bam_nt16_rev_table[bam1_seqi(bam1_seq(p->b), p->qpos + j)];
157                                         putchar(bam1_strand(p->b)? tolower(c) : toupper(c));
158                                 }
159                         } else if (p->indel < 0) {
160                                 printf("%d", p->indel);
161                                 for (j = 1; j <= -p->indel; ++j) {
162                                         c = (d->ref && (int)pos+j < d->len)? d->ref[pos+j] : 'N';
163                                         putchar(bam1_strand(p->b)? tolower(c) : toupper(c));
164                                 }
165                         }
166                 } else putchar('*');
167                 if (p->is_tail) putchar('$');
168         }
169         putchar('\t');
170         for (i = 0; i < n; ++i) {
171                 const bam_pileup1_t *p = pu + i;
172                 int c = bam1_qual(p->b)[p->qpos] + 33;
173                 if (c > 126) c = 126;
174                 putchar(c);
175         }
176         if (d->format & BAM_PLF_SIMPLE) {
177                 putchar('\t');
178                 for (i = 0; i < n; ++i) {
179                         int c = pu[i].b->core.qual + 33;
180                         if (c > 126) c = 126;
181                         putchar(c);
182                 }
183         }
184         putchar('\n');
185         if (r) { // then print indel line
186                 printf("%s\t%d\t*\t", d->h->target_name[tid], pos + 1);
187                 if (r->gt < 2) printf("%s/%s\t", r->s[r->gt], r->s[r->gt]);
188                 else printf("%s/%s\t", r->s[0], r->s[1]);
189                 printf("%d\t%d\t", r->q_cns, r->q_ref);
190                 printf("%d\t%d\t", max_mapq, n);
191                 printf("%s\t%s\t", r->s[0], r->s[1]);
192                 //printf("%d\t%d\t", r->gl[0], r->gl[1]);
193                 printf("%d\t%d\t%d\t%d\n", r->cnt1, r->cnt2, r->cnt_ambi, r->cnt_anti);
194                 bam_maqindel_ret_destroy(r);
195         }
196         return 0;
197 }
198
199 int bam_pileup(int argc, char *argv[])
200 {
201         int c;
202         char *fn_list = 0, *fn_fa = 0, *fn_pos = 0;
203         pu_data_t *d = (pu_data_t*)calloc(1, sizeof(pu_data_t));
204         d->tid = -1; d->mask = BAM_DEF_MASK;
205         d->c = bam_maqcns_init();
206         d->ido = bam_maqindel_opt_init();
207         while ((c = getopt(argc, argv, "st:f:cT:N:r:l:im:gI:G:")) >= 0) {
208                 switch (c) {
209                 case 's': d->format |= BAM_PLF_SIMPLE; break;
210                 case 't': fn_list = strdup(optarg); break;
211                 case 'l': fn_pos = strdup(optarg); break;
212                 case 'f': fn_fa = strdup(optarg); break;
213                 case 'T': d->c->theta = atof(optarg); break;
214                 case 'N': d->c->n_hap = atoi(optarg); break;
215                 case 'r': d->c->het_rate = atoi(optarg); break;
216                 case 'c': d->format |= BAM_PLF_CNS; break;
217                 case 'i': d->format |= BAM_PLF_INDEL_ONLY; break;
218                 case 'm': d->mask = atoi(optarg); break;
219                 case 'g': d->format |= BAM_PLF_GLF; break;
220                 case 'I': d->ido->q_indel = atoi(optarg); break;
221                 case 'G': d->ido->r_indel = atof(optarg); break;
222                 default: fprintf(stderr, "Unrecognizd option '-%c'.\n", c); return 1;
223                 }
224         }
225         if (optind == argc) {
226                 fprintf(stderr, "\n");
227                 fprintf(stderr, "Usage:  bamtk pileup [options] <in.bam>|<in.sam>\n\n");
228                 fprintf(stderr, "Option: -s        simple (yet incomplete) pileup format\n");
229                 fprintf(stderr, "        -i        only show lines/consensus with indels\n");
230                 fprintf(stderr, "        -m INT    filtering reads with bits in INT [%d]\n", d->mask);
231                 fprintf(stderr, "        -t FILE   list of reference sequences (assume the input is in SAM)\n");
232                 fprintf(stderr, "        -l FILE   list of sites at which pileup is output\n");
233                 fprintf(stderr, "        -f FILE   reference sequence in the FASTA format\n\n");
234                 fprintf(stderr, "        -c        output the maq consensus sequence\n");
235                 fprintf(stderr, "        -g        output in the extended GLT format (suppressing -c/-i/-s)\n");
236                 fprintf(stderr, "        -T FLOAT  theta in maq consensus calling model (for -c/-g) [%f]\n", d->c->theta);
237                 fprintf(stderr, "        -N INT    number of haplotypes in the sample (for -c/-g) [%d]\n", d->c->n_hap);
238                 fprintf(stderr, "        -r FLOAT  prior of a difference between two haplotypes (for -c/-g) [%f]\n", d->c->het_rate);
239                 fprintf(stderr, "        -G FLOAT  prior of an indel between two haplotypes (for -c/-g) [%f]\n", d->ido->r_indel);
240                 fprintf(stderr, "        -I INT    phred prob. of an indel in sequencing/prep. (for -c/-g) [%d]\n", d->ido->q_indel);
241                 fprintf(stderr, "\n");
242                 free(fn_list); free(fn_fa); free(d);
243                 return 1;
244         }
245         if (fn_fa) d->fai = fai_load(fn_fa);
246         free(fn_fa);
247         bam_maqcns_prepare(d->c);
248         if (d->format & BAM_PLF_GLF) {
249                 glf_header_t *h;
250                 h = glf_header_init();
251                 d->fp = bgzf_fdopen(fileno(stdout), "w");
252                 glf_header_write(d->fp, h);
253                 glf_header_destroy(h);
254         }
255         if (fn_list) {
256                 tamFile fp;
257                 bam1_t *b;
258                 int ret;
259                 bam_plbuf_t *buf = bam_plbuf_init(pileup_func, d);
260                 bam_plbuf_set_mask(buf, d->mask);
261                 d->h = sam_header_read2(fn_list);
262                 if (fn_pos) d->hash = load_pos(fn_pos, d->h);
263                 fp = sam_open(argv[optind]);
264                 b = (bam1_t*)calloc(1, sizeof(bam1_t));
265                 while ((ret = sam_read1(fp, d->h, b)) >= 0)
266                         bam_plbuf_push(b, buf);
267                 bam_plbuf_push(0, buf);
268                 bam_plbuf_destroy(buf);
269                 bam_destroy1(b);
270                 sam_close(fp);
271         } else {
272                 bamFile fp;
273                 fp = (strcmp(argv[optind], "-") == 0)? bam_dopen(fileno(stdin), "r") : bam_open(argv[optind], "r");
274                 d->h = bam_header_read(fp);
275                 if (fn_pos) d->hash = load_pos(fn_pos, d->h);
276                 bam_pileup_file(fp, d->mask, pileup_func, d);
277                 bam_close(fp);
278         }
279         if (d->format & BAM_PLF_GLF) bgzf_close(d->fp);
280         free(fn_pos); free(fn_list);
281         kh_destroy(64, d->hash);
282         bam_header_destroy(d->h);
283         if (d->fai) fai_destroy(d->fai);
284         bam_maqcns_destroy(d->c);
285         free(d->ido); free(d->ref); free(d);
286         return 0;
287 }