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
|
#include "bcftools.pysam.h"
/* vcfgtcheck.c -- Check sample identity.
Copyright (C) 2013-2018 Genome Research Ltd.
Author: Petr Danecek <pd3@sanger.ac.uk>
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. */
#include <stdio.h>
#include <stdarg.h>
#include <unistd.h>
#include <getopt.h>
#include <ctype.h>
#include <string.h>
#include <errno.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <math.h>
#include <htslib/vcf.h>
#include <htslib/synced_bcf_reader.h>
#include <htslib/vcfutils.h>
#include <inttypes.h>
#include "bcftools.h"
#include "hclust.h"
typedef struct
{
bcf_srs_t *files; // first reader is the query VCF - single sample normally or multi-sample for cross-check
bcf_hdr_t *gt_hdr, *sm_hdr; // VCF with genotypes to compare against and the query VCF
int ntmp_arr, npl_arr;
int32_t *tmp_arr, *pl_arr;
double *lks, *sites, min_inter_err, max_intra_err;
int *cnts, *dps, hom_only, cross_check, all_sites;
char *cwd, **argv, *gt_fname, *plot, *query_sample, *target_sample;
int argc, no_PLs, narr, nsmpl;
}
args_t;
FILE *open_file(char **fname, const char *mode, const char *fmt, ...);
char *msprintf(const char *fmt, ...);
void mkdir_p(const char *fmt, ...);
void py_plot(char *script)
{
mkdir_p(script);
int len = strlen(script);
char *cmd = !strcmp(".py",script+len-3) ? msprintf("python %s", script) : msprintf("python %s.py", script);
int ret = system(cmd);
if ( ret ) fprintf(bcftools_stderr, "The command returned non-zero status %d: %s\n", ret, cmd);
free(cmd);
}
static void plot_check(args_t *args, char *target_sample, char *query_sample)
{
char *fname;
FILE *fp = open_file(&fname, "w", "%s.py", args->plot);
fprintf(fp,
"import matplotlib as mpl\n"
"mpl.use('Agg')\n"
"import matplotlib.pyplot as plt\n"
"import matplotlib.gridspec as gridspec\n"
"import csv\n"
"csv.register_dialect('tab', delimiter='\\t', quoting=csv.QUOTE_NONE)\n"
"\n"
"sample_ids = False\n"
"\n"
"dat = []\n"
"with open('%s.tab', 'r') as f:\n"
" reader = csv.reader(f, 'tab')\n"
" for row in reader:\n"
" if row[0][0]=='#': continue\n"
" if row[0]!='CN': continue\n"
" tgt = 0\n"
" if row[4]=='%s': tgt = 1\n"
" dat.append([float(row[1]), float(row[2]), float(row[3]), tgt, row[4]])\n"
"\n"
"dat = sorted(dat)\n"
"\n"
"iq = -1; dp = 0\n"
"for i in range(len(dat)):\n"
" if iq==-1 and dat[i][3]==1: iq = i\n"
" dp += dat[i][2]\n"
"dp /= len(dat)\n"
"\n"
"fig,ax1 = plt.subplots(figsize=(8,5))\n"
"ax2 = ax1.twinx()\n"
"plots = ax1.plot([x[0] for x in dat],'o-', ms=3, color='g', mec='g', label='Discordance (total)')\n"
"plots += ax1.plot([x[1] for x in dat], '^', ms=3, color='r', mec='r', label='Discordance (avg per site)')\n"
"plots += ax2.plot([x[2] for x in dat],'v', ms=3, color='k', label='Number of sites')\n"
"if iq!=-1:\n"
" ax1.plot([iq],[dat[iq][0]],'o',color='orange', ms=9)\n"
" ax1.annotate('%s',xy=(iq,dat[iq][0]), xytext=(5,5), textcoords='offset points',fontsize='xx-small',rotation=45,va='bottom',ha='left')\n"
" ax1.plot([iq],[dat[iq][1]],'^',color='red', ms=5)\n"
"for tl in ax1.get_yticklabels(): tl.set_color('g')\n"
"for tl in ax2.get_yticklabels(): tl.set_color('k'); tl.set_fontsize(9)\n"
"min_dp = min([x[2] for x in dat])\n"
"max_dp = max([x[2] for x in dat])\n"
"ax2.set_ylim(min_dp-1,max_dp+1)\n"
"ax1.set_title('Discordance with %s')\n"
"ax1.set_xlim(-0.05*len(dat),1.05*(len(dat)-1))\n"
"ax1.set_xlabel('Sample ID')\n"
"plt.subplots_adjust(left=0.1,right=0.9,bottom=0.1,top=0.9)\n"
"if sample_ids:\n"
" ax1.set_xticks(range(len(dat)))\n"
" ax1.set_xticklabels([x[4] for x in dat],**{'rotation':45, 'ha':'right', 'fontsize':8})\n"
" plt.subplots_adjust(bottom=0.2)\n"
"ax1.set_ylabel('Discordance',color='g')\n"
"ax2.set_ylabel('Number of sites',color='k')\n"
"ax2.ticklabel_format(style='sci', scilimits=(-3,2), axis='y')\n"
"ax1.ticklabel_format(style='sci', scilimits=(-3,2), axis='y')\n"
"labels = [l.get_label() for l in plots]\n"
"plt.legend(plots,labels,numpoints=1,markerscale=1,loc='best',prop={'size':10},frameon=False)\n"
"plt.savefig('%s.png')\n"
"plt.close()\n"
"\n", args->plot, target_sample, target_sample, query_sample, args->plot
);
fclose(fp);
py_plot(fname);
free(fname);
}
#if 0
static void plot_cross_check(args_t *args)
{
char *fname;
FILE *fp = open_file(&fname, "w", "%s.py", args->plot);
fprintf(fp,
"import matplotlib as mpl\n"
"mpl.use('Agg')\n"
"import matplotlib.pyplot as plt\n"
"import matplotlib.gridspec as gridspec\n"
"import csv\n"
"csv.register_dialect('tab', delimiter='\\t', quoting=csv.QUOTE_NONE)\n"
"avg = []\n"
"dp = []\n"
"sm2id = {}\n"
"dat = None\n"
"min = None\n"
"max = None\n"
"with open('%s.tab', 'r') as f:\n"
" reader = csv.reader(f, 'tab')\n"
" i = 0\n"
" for row in reader:\n"
" if row[0]=='SM':\n"
" sm2id[row[4]] = i\n"
" avg.append([i,float(row[1])])\n"
" dp.append([i,float(row[2])])\n"
" i += 1\n"
" elif row[0]=='CN':\n"
" val = 0\n"
" if int(row[2])!=0: val = float(row[1])/int(row[2])\n"
" if not dat:\n"
" dat = [[0]*len(sm2id) for x in xrange(len(sm2id))]\n"
" min = val\n"
" max = val\n"
" id_i = sm2id[row[4]]\n"
" id_j = sm2id[row[5]]\n"
" dat[id_i][id_j] = val\n"
" dat[id_j][id_i] = val\n"
" if min > val: min = val\n"
" if max < val: max = val\n"
"\n"
"if len(sm2id)<=1: exit(1)\n"
"if min==max: exit(1)\n"
"\n"
"fig = plt.figure(figsize=(6,7))\n"
"gs = gridspec.GridSpec(2, 1, height_ratios=[1, 1.5])\n"
"ax1 = plt.subplot(gs[0])\n"
"ax2 = plt.subplot(gs[1])\n"
"\n"
"ax1.plot([x[0] for x in avg],[x[1] for x in avg],'^-', ms=3, color='k')\n"
"ax3 = ax1.twinx()\n"
"ax3.plot([x[0] for x in dp],[x[1] for x in dp],'^-', ms=3, color='r',mec='r')\n"
"for tl in ax3.get_yticklabels():\n"
" tl.set_color('r')\n"
" tl.set_fontsize(9)\n"
"\n"
"im = ax2.imshow(dat,clim=(min),interpolation='nearest',origin='lower')\n"
"cb1 = plt.colorbar(im,ax=ax2)\n"
"cb1.set_label('Pairwise discordance')\n"
"for t in cb1.ax.get_yticklabels(): t.set_fontsize(9)\n"
"\n"
"ax1.tick_params(axis='both', which='major', labelsize=9)\n"
"ax1.tick_params(axis='both', which='minor', labelsize=9)\n"
"ax2.tick_params(axis='both', which='major', labelsize=9)\n"
"ax2.tick_params(axis='both', which='minor', labelsize=9)\n"
"\n"
"ax1.set_title('Sample Discordance Score')\n"
"ax2.set_ylabel('Sample ID')\n"
"ax2.set_xlabel('Sample ID')\n"
"ax3.set_ylabel('Average Depth',color='r')\n"
"ax1.set_xlabel('Sample ID')\n"
"ax1.set_ylabel('Average discordance')\n"
"\n"
"plt.subplots_adjust(left=0.15,right=0.87,bottom=0.08,top=0.93,hspace=0.25)\n"
"plt.savefig('%s.png')\n"
"plt.close()\n"
"\n", args->plot,args->plot
);
fclose(fp);
py_plot(fname);
free(fname);
}
#endif
static void init_data(args_t *args)
{
args->sm_hdr = args->files->readers[0].header;
if ( !bcf_hdr_nsamples(args->sm_hdr) ) error("No samples in %s?\n", args->files->readers[0].fname);
if ( !args->cross_check )
{
args->gt_hdr = args->files->readers[1].header;
int nsamples = bcf_hdr_nsamples(args->gt_hdr);
if ( !nsamples ) error("No samples in %s?\n", args->files->readers[1].fname);
args->lks = (double*) calloc(nsamples,sizeof(double));
args->cnts = (int*) calloc(nsamples,sizeof(int));
args->sites = (double*) calloc(nsamples,sizeof(double));
args->dps = (int*) calloc(nsamples,sizeof(int));
}
}
static void destroy_data(args_t *args)
{
free(args->lks); free(args->cnts); free(args->dps); free(args->cwd); free(args->sites);
}
static int allele_to_int(bcf1_t *line, char *allele)
{
int i;
for (i=0; i<line->n_allele; i++)
if ( !strcmp(allele,line->d.allele[i]) ) return i;
if ( strcmp(line->d.allele[i-1],"X") ) return -1;
return i-1;
}
static int init_gt2ipl(args_t *args, bcf1_t *gt_line, bcf1_t *sm_line, int *gt2ipl, int n_gt2ipl)
{
int i, j;
for (i=0; i<n_gt2ipl; i++) gt2ipl[i] = -1;
for (i=0; i<gt_line->n_allele; i++)
{
// find which of the sm_alleles (k) corresponds to the gt_allele (i)
int k = allele_to_int(sm_line, gt_line->d.allele[i]);
if ( k<0 ) return 0;
for (j=0; j<=i; j++)
{
int l = allele_to_int(sm_line, gt_line->d.allele[j]);
if ( l<0 ) return 0;
gt2ipl[ bcf_ij2G(j,i) ] = k<=l ? bcf_ij2G(k,l) : bcf_ij2G(l,k);
}
}
//for (i=0; i<n_gt2ipl; i++) fprintf(bcftools_stdout, "%d .. %d\n", i,gt2ipl[i]);
return 1;
}
static void set_cwd(args_t *args)
{
int i;
char *buf;
size_t nbuf = 500;
args->cwd = (char*) malloc(sizeof(char)*nbuf);
for (i=0; i<5; i++)
{
if ( (buf = getcwd(args->cwd, nbuf)) ) break;
nbuf *= 2;
args->cwd = (char*) realloc(args->cwd, sizeof(char)*nbuf);
}
assert(buf);
}
static void print_header(args_t *args, FILE *fp)
{
fprintf(fp, "# This file was produced by bcftools (%s+htslib-%s), the command line was:\n", bcftools_version(), hts_version());
fprintf(fp, "# \t bcftools %s ", args->argv[0]);
int i;
for (i=1; i<args->argc; i++)
fprintf(fp, " %s",args->argv[i]);
fprintf(fp, "\n# and the working directory was:\n");
fprintf(fp, "# \t %s\n#\n", args->cwd);
}
static int fake_PLs(args_t *args, bcf_hdr_t *hdr, bcf1_t *line)
{
// PLs not present, use GTs instead.
int fake_PL = args->no_PLs ? args->no_PLs : 99; // with 1, discordance is the number of non-matching GTs
int nsm_gt, i;
if ( (nsm_gt=bcf_get_genotypes(hdr, line, &args->tmp_arr, &args->ntmp_arr)) <= 0 )
error("GT not present at %s:%d?\n", hdr->id[BCF_DT_CTG][line->rid].key, line->pos+1);
nsm_gt /= bcf_hdr_nsamples(hdr);
int npl = line->n_allele*(line->n_allele+1)/2;
hts_expand(int,npl*bcf_hdr_nsamples(hdr),args->npl_arr,args->pl_arr);
for (i=0; i<bcf_hdr_nsamples(hdr); i++)
{
int *gt_ptr = args->tmp_arr + i*nsm_gt;
int j, *pl_ptr = args->pl_arr + i*npl;
if ( bcf_gt_is_missing(gt_ptr[0]) || bcf_gt_is_missing(gt_ptr[1]) ) // missing genotype
{
for (j=0; j<npl; j++) pl_ptr[j] = -1;
}
else
{
int a = bcf_gt_allele(gt_ptr[0]);
int b = bcf_gt_allele(gt_ptr[1]);
for (j=0; j<npl; j++) pl_ptr[j] = fake_PL;
int idx = bcf_alleles2gt(a,b);
pl_ptr[idx] = 0;
}
}
return npl;
}
static int cmp_doubleptr(const void *_a, const void *_b)
{
double *a = *((double**)_a);
double *b = *((double**)_b);
if ( *a < *b ) return -1;
else if ( *a == *b ) return 0;
return 1;
}
static void check_gt(args_t *args)
{
int i,ret, *gt2ipl = NULL, m_gt2ipl = 0, *gt_arr = NULL, ngt_arr = 0;
int fake_pls = args->no_PLs;
// Initialize things: check which tags are defined in the header, sample names etc.
if ( bcf_hdr_id2int(args->gt_hdr, BCF_DT_ID, "GT")<0 ) error("[E::%s] GT not present in the header of %s?\n", __func__, args->files->readers[1].fname);
if ( bcf_hdr_id2int(args->sm_hdr, BCF_DT_ID, "PL")<0 )
{
if ( bcf_hdr_id2int(args->sm_hdr, BCF_DT_ID, "GT")<0 )
error("[E::%s] Neither PL nor GT present in the header of %s\n", __func__, args->files->readers[0].fname);
if ( !args->no_PLs )
fprintf(bcftools_stderr,"Warning: PL not present in the header of %s, using GT instead\n", args->files->readers[0].fname);
fake_pls = 1;
}
FILE *fp = args->plot ? open_file(NULL, "w", "%s.tab", args->plot) : bcftools_stdout;
print_header(args, fp);
int tgt_isample = -1, query_isample = 0;
if ( args->target_sample )
{
tgt_isample = bcf_hdr_id2int(args->gt_hdr, BCF_DT_SAMPLE, args->target_sample);
if ( tgt_isample<0 ) error("No such sample in %s: [%s]\n", args->files->readers[1].fname, args->target_sample);
}
if ( args->all_sites )
{
if ( tgt_isample==-1 )
{
fprintf(bcftools_stderr,"No target sample selected for comparison, using the first sample in %s: %s\n", args->gt_fname,args->gt_hdr->samples[0]);
tgt_isample = 0;
}
}
if ( args->query_sample )
{
query_isample = bcf_hdr_id2int(args->sm_hdr, BCF_DT_SAMPLE, args->query_sample);
if ( query_isample<0 ) error("No such sample in %s: [%s]\n", args->files->readers[0].fname, args->query_sample);
}
if ( args->all_sites )
fprintf(fp, "# [1]SC, Site by Site Comparison\t[2]Chromosome\t[3]Position\t[4]-g alleles\t[5]-g GT (%s)\t[6]match log LK\t[7]Query alleles\t[8-]Query PLs (%s)\n",
args->gt_hdr->samples[tgt_isample],args->sm_hdr->samples[query_isample]);
// Main loop
float prev_lk = 0;
while ( (ret=bcf_sr_next_line(args->files)) )
{
if ( ret!=2 ) continue;
bcf1_t *sm_line = args->files->readers[0].buffer[0]; // the query file
bcf1_t *gt_line = args->files->readers[1].buffer[0]; // the -g target file
bcf_unpack(sm_line, BCF_UN_FMT);
bcf_unpack(gt_line, BCF_UN_FMT);
// Init mapping from target genotype index to the sample's PL fields
int n_gt2ipl = gt_line->n_allele*(gt_line->n_allele + 1)/2;
if ( n_gt2ipl > m_gt2ipl )
{
m_gt2ipl = n_gt2ipl;
gt2ipl = (int*) realloc(gt2ipl, sizeof(int)*m_gt2ipl);
}
if ( !init_gt2ipl(args, gt_line, sm_line, gt2ipl, n_gt2ipl) ) continue;
// Target genotypes
int ngt, npl;
if ( (ngt=bcf_get_genotypes(args->gt_hdr, gt_line, >_arr, &ngt_arr)) <= 0 )
error("GT not present at %s:%d?", args->gt_hdr->id[BCF_DT_CTG][gt_line->rid].key, gt_line->pos+1);
ngt /= bcf_hdr_nsamples(args->gt_hdr);
if ( ngt!=2 ) continue; // checking only diploid genotypes
// Sample PLs
if ( !fake_pls )
{
if ( (npl=bcf_get_format_int32(args->sm_hdr, sm_line, "PL", &args->pl_arr, &args->npl_arr)) <= 0 )
{
if ( sm_line->n_allele==1 )
{
// PL values may not be present when ALT=. (mpileup/bcftools output), in that case
// switch automatically to GT at these sites
npl = fake_PLs(args, args->sm_hdr, sm_line);
}
else
error("PL not present at %s:%d?\n", args->sm_hdr->id[BCF_DT_CTG][sm_line->rid].key, sm_line->pos+1);
}
else
npl /= bcf_hdr_nsamples(args->sm_hdr);
}
else
npl = fake_PLs(args, args->sm_hdr, sm_line);
// Calculate likelihoods for all samples, assuming diploid genotypes
// For faster access to genotype likelihoods (PLs) of the query sample
int max_ipl, *pl_ptr = args->pl_arr + query_isample*npl;
double sum_pl = 0; // for converting PLs to probs
for (max_ipl=0; max_ipl<npl; max_ipl++)
{
if ( pl_ptr[max_ipl]==bcf_int32_vector_end ) break;
if ( pl_ptr[max_ipl]==bcf_int32_missing ) continue;
sum_pl += pow(10, -0.1*pl_ptr[max_ipl]);
}
if ( sum_pl==0 ) continue; // no PLs present
if ( fake_pls && args->no_PLs==1 ) sum_pl = -1;
// The main stats: concordance of the query sample with the target -g samples
for (i=0; i<bcf_hdr_nsamples(args->gt_hdr); i++)
{
int *gt_ptr = gt_arr + i*ngt;
if ( gt_ptr[1]==bcf_int32_vector_end ) continue; // skip haploid genotypes
if ( bcf_gt_is_missing(gt_ptr[0]) || bcf_gt_is_missing(gt_ptr[1]) ) continue;
int a = bcf_gt_allele(gt_ptr[0]);
int b = bcf_gt_allele(gt_ptr[1]);
if ( args->hom_only && a!=b ) continue; // heterozygous genotype
int igt_tgt = igt_tgt = bcf_alleles2gt(a,b); // genotype index in the target file
int igt_qry = gt2ipl[igt_tgt]; // corresponding genotype in query file
if ( igt_qry>=max_ipl || pl_ptr[igt_qry]<0 ) continue; // genotype not present in query sample: haploid or missing
args->lks[i] += sum_pl<0 ? -pl_ptr[igt_qry] : log(pow(10, -0.1*pl_ptr[igt_qry])/sum_pl);
args->sites[i]++;
}
if ( args->all_sites )
{
// Print LKs at all sites for debugging
int *gt_ptr = gt_arr + tgt_isample*ngt;
if ( gt_ptr[1]==bcf_int32_vector_end ) continue; // skip haploid genotypes
int a = bcf_gt_allele(gt_ptr[0]);
int b = bcf_gt_allele(gt_ptr[1]);
if ( args->hom_only && a!=b ) continue; // heterozygous genotype
fprintf(fp, "SC\t%s\t%d", args->gt_hdr->id[BCF_DT_CTG][gt_line->rid].key, gt_line->pos+1);
for (i=0; i<gt_line->n_allele; i++) fprintf(fp, "%c%s", i==0?'\t':',', gt_line->d.allele[i]);
fprintf(fp, "\t%s/%s", a>=0 ? gt_line->d.allele[a] : ".", b>=0 ? gt_line->d.allele[b] : ".");
fprintf(fp, "\t%f", args->lks[query_isample]-prev_lk);
prev_lk = args->lks[query_isample];
int igt, *pl_ptr = args->pl_arr + query_isample*npl; // PLs of the query sample
for (i=0; i<sm_line->n_allele; i++) fprintf(fp, "%c%s", i==0?'\t':',', sm_line->d.allele[i]);
for (igt=0; igt<npl; igt++)
if ( pl_ptr[igt]==bcf_int32_vector_end ) break;
else if ( pl_ptr[igt]==bcf_int32_missing ) fprintf(fp, ".");
else fprintf(fp, "\t%d", pl_ptr[igt]);
fprintf(fp, "\n");
}
}
free(gt2ipl);
free(gt_arr);
free(args->pl_arr);
free(args->tmp_arr);
// To be able to plot total discordance (=number of mismatching GTs with -G1) in the same
// plot as discordance per site, the latter must be scaled to the same range
int nsamples = bcf_hdr_nsamples(args->gt_hdr);
double extreme_lk = 0, extreme_lk_per_site = 0;
for (i=0; i<nsamples; i++)
{
if ( args->lks[i] < extreme_lk ) extreme_lk = args->lks[i];
if ( args->sites[i] && args->lks[i]/args->sites[i] < extreme_lk_per_site ) extreme_lk_per_site = args->lks[i]/args->sites[i];
}
// Sorted output
double **p = (double**) malloc(sizeof(double*)*nsamples);
for (i=0; i<nsamples; i++) p[i] = &args->lks[i];
qsort(p, nsamples, sizeof(int*), cmp_doubleptr);
fprintf(fp, "# [1]CN\t[2]Discordance with %s (total)\t[3]Discordance (avg score per site)\t[4]Number of sites compared\t[5]Sample\t[6]Sample ID\n", args->sm_hdr->samples[query_isample]);
for (i=0; i<nsamples; i++)
{
int idx = p[i] - args->lks;
double per_site = 0;
if ( args->sites[idx] )
{
if ( args->sites[idx] && extreme_lk_per_site )
{
per_site = args->lks[idx]/args->sites[idx];
per_site *= extreme_lk / extreme_lk_per_site;
}
else
per_site = 0;
}
fprintf(fp, "CN\t%e\t%e\t%.0f\t%s\t%d\n", fabs(args->lks[idx]), fabs(per_site), args->sites[idx], args->gt_hdr->samples[idx], i);
}
if ( args->plot )
{
fclose(fp);
plot_check(args, args->target_sample ? args->target_sample : "", args->sm_hdr->samples[query_isample]);
}
}
// static inline int is_hom_most_likely(int nals, int *pls)
// {
// int ia, ib, idx = 1, min_is_hom = 1, min_pl = pls[0];
// for (ia=1; ia<nals; ia++)
// {
// for (ib=0; ib<ia; ib++)
// {
// if ( pls[idx] < min_pl ) { min_pl = pls[idx]; min_is_hom = 0; }
// idx++;
// }
// if ( pls[idx] < min_pl ) { min_pl = pls[idx]; min_is_hom = 1; }
// idx++;
// }
// return min_is_hom;
// }
int process_GT(args_t *args, bcf1_t *line, uint32_t *ntot, uint32_t *ndif)
{
int ngt = bcf_get_genotypes(args->sm_hdr, line, &args->tmp_arr, &args->ntmp_arr);
if ( ngt<=0 ) return 1; // GT not present
if ( ngt!=args->nsmpl*2 ) return 2; // not diploid
ngt /= args->nsmpl;
int i,j, idx = 0;
for (i=1; i<args->nsmpl; i++)
{
int32_t *a = args->tmp_arr + i*ngt;
if ( bcf_gt_is_missing(a[0]) || bcf_gt_is_missing(a[1]) || a[1]==bcf_int32_vector_end ) { idx+=i; continue; }
int agt = 1<<bcf_gt_allele(a[0]) | 1<<bcf_gt_allele(a[1]);
for (j=0; j<i; j++)
{
int32_t *b = args->tmp_arr + j*ngt;
if ( bcf_gt_is_missing(b[0]) || bcf_gt_is_missing(b[1]) || b[1]==bcf_int32_vector_end ) { idx++; continue; }
int bgt = 1<<bcf_gt_allele(b[0]) | 1<<bcf_gt_allele(b[1]);
ntot[idx]++;
if ( agt!=bgt ) ndif[idx]++;
idx++;
}
}
return 0;
}
int process_PL(args_t *args, bcf1_t *line, uint32_t *ntot, uint32_t *ndif)
{
int npl = bcf_get_format_int32(args->sm_hdr, line, "PL", &args->tmp_arr, &args->ntmp_arr);
if ( npl<=0 ) return 1; // PL not present
npl /= args->nsmpl;
int i,j,k, idx = 0;
for (i=1; i<args->nsmpl; i++)
{
int32_t *a = args->tmp_arr + i*npl;
int imin = -1;
for (k=0; k<npl; k++)
{
if ( a[k]==bcf_int32_vector_end ) break;
if ( a[k]==bcf_int32_missing ) continue;
if ( imin==-1 || a[imin] > a[k] ) imin = k;
}
if ( imin<0 ) { idx+=i; continue; }
for (j=0; j<i; j++)
{
int32_t *b = args->tmp_arr + j*npl;
int jmin = -1;
for (k=0; k<npl; k++)
{
if ( b[k]==bcf_int32_vector_end ) break;
if ( b[k]==bcf_int32_missing ) continue;
if ( jmin==-1 || b[jmin] > b[k] ) jmin = k;
}
if ( jmin<0 ) { idx++; continue; }
ntot[idx]++;
if ( imin!=jmin ) ndif[idx]++;
idx++;
}
}
return 0;
}
static void cross_check_gts(args_t *args)
{
// Initialize things: check which tags are defined in the header, sample names etc.
if ( bcf_hdr_id2int(args->sm_hdr, BCF_DT_ID, "PL")<0 )
{
if ( bcf_hdr_id2int(args->sm_hdr, BCF_DT_ID, "GT")<0 )
error("[E::%s] Neither PL nor GT present in the header of %s\n", __func__, args->files->readers[0].fname);
if ( !args->no_PLs ) {
fprintf(bcftools_stderr,"Warning: PL not present in the header of %s, using GT instead\n", args->files->readers[0].fname);
args->no_PLs = 99;
}
}
args->nsmpl = bcf_hdr_nsamples(args->sm_hdr);
args->narr = (args->nsmpl-1)*args->nsmpl/2;
uint32_t *ndif = (uint32_t*) calloc(args->narr,4);
uint32_t *ntot = (uint32_t*) calloc(args->narr,4);
while ( bcf_sr_next_line(args->files) )
{
bcf1_t *line = bcf_sr_get_line(args->files,0);
// use PLs unless no_PLs is set and GT exists
if ( args->no_PLs )
{
if ( process_GT(args,line,ntot,ndif)==0 ) continue;
}
process_PL(args,line,ntot,ndif);
}
FILE *fp = bcftools_stdout;
print_header(args, fp);
float *tmp = (float*)malloc(sizeof(float)*args->nsmpl*(args->nsmpl-1)/2);
// Output pairwise distances
fprintf(fp, "# ERR, error rate\t[2]Pairwise error rate\t[3]Number of sites compared\t[4]Sample i\t[5]Sample j\n");
int i,j, idx = 0;
for (i=0; i<args->nsmpl; i++)
{
for (j=0; j<i; j++)
{
float err = ntot[idx] ? (float)ndif[idx]/ntot[idx] : 1e-10;
fprintf(fp, "ERR\t%f\t%"PRId32"\t%s\t%s\n", err, ntot[idx],args->sm_hdr->samples[i],args->sm_hdr->samples[j]);
PDIST(tmp,i,j) = err;
idx++;
}
}
// Cluster samples
int nlist;
float clust_max_err = args->max_intra_err;
hclust_t *clust = hclust_init(args->nsmpl,tmp);
cluster_t *list = hclust_create_list(clust,args->min_inter_err,&clust_max_err,&nlist);
fprintf(fp, "# CLUSTER\t[2]Maximum inter-cluster ERR\t[3-]List of samples\n");
for (i=0; i<nlist; i++)
{
fprintf(fp,"CLUSTER\t%f", list[i].dist);
for (j=0; j<list[i].nmemb; j++)
fprintf(fp,"\t%s",args->sm_hdr->samples[list[i].memb[j]]);
fprintf(fp,"\n");
}
hclust_destroy_list(list,nlist);
// Debugging output: the cluster graph and data used for deciding
char **dbg = hclust_explain(clust,&nlist);
for (i=0; i<nlist; i++)
fprintf(fp,"DBG\t%s\n", dbg[i]);
fprintf(fp, "# TH, clustering threshold\t[2]Value\nTH\t%f\n",clust_max_err);
fprintf(fp, "# DOT\t[2]Cluster graph, visualize e.g. as \"this-output.txt | grep ^DOT | cut -f2- | dot -Tsvg -o graph.svg\"\n");
fprintf(fp, "DOT\t%s\n", hclust_create_dot(clust,args->sm_hdr->samples,clust_max_err));
hclust_destroy(clust);
free(tmp);
// Deprecated output for temporary backward compatibility
fprintf(fp, "# Warning: The CN block is deprecated and will be removed in future releases. Use ERR instead.\n");
fprintf(fp, "# [1]CN\t[2]Discordance\t[3]Number of sites\t[4]Average minimum depth\t[5]Sample i\t[6]Sample j\n");
idx = 0;
for (i=0; i<args->nsmpl; i++)
{
for (j=0; j<i; j++)
{
fprintf(fp, "CN\t%"PRId32"\t%"PRId32"\t0\t%s\t%s\n", ndif[idx], ntot[idx],args->sm_hdr->samples[i],args->sm_hdr->samples[j]);
idx++;
}
}
free(ndif);
free(ntot);
free(args->tmp_arr);
}
static char *init_prefix(char *prefix)
{
int len = strlen(prefix);
if ( prefix[len-1] == '/' || prefix[len-1] == '\\' )
return msprintf("%sgtcheck", prefix);
return strdup(prefix);
}
static void usage(void)
{
fprintf(bcftools_stderr, "\n");
fprintf(bcftools_stderr, "About: Check sample identity. With no -g BCF given, multi-sample cross-check is performed.\n");
fprintf(bcftools_stderr, "Usage: bcftools gtcheck [options] [-g <genotypes.vcf.gz>] <query.vcf.gz>\n");
fprintf(bcftools_stderr, "\n");
fprintf(bcftools_stderr, "Options:\n");
fprintf(bcftools_stderr, " -a, --all-sites output comparison for all sites\n");
fprintf(bcftools_stderr, " -c, --cluster <min,max> min inter- and max intra-sample error [0.23,-0.3]\n");
fprintf(bcftools_stderr, " -g, --genotypes <file> genotypes to compare against\n");
fprintf(bcftools_stderr, " -G, --GTs-only <int> use GTs, ignore PLs, using <int> for unseen genotypes [99]\n");
fprintf(bcftools_stderr, " -H, --homs-only homozygous genotypes only (useful for low coverage data)\n");
fprintf(bcftools_stderr, " -p, --plot <prefix> plot\n");
fprintf(bcftools_stderr, " -r, --regions <region> restrict to comma-separated list of regions\n");
fprintf(bcftools_stderr, " -R, --regions-file <file> restrict to regions listed in a file\n");
fprintf(bcftools_stderr, " -s, --query-sample <string> query sample (by default the first sample is checked)\n");
fprintf(bcftools_stderr, " -S, --target-sample <string> target sample in the -g file (used only for plotting)\n");
fprintf(bcftools_stderr, " -t, --targets <region> similar to -r but streams rather than index-jumps\n");
fprintf(bcftools_stderr, " -T, --targets-file <file> similar to -R but streams rather than index-jumps\n");
fprintf(bcftools_stderr, "\n");
exit(1);
}
int main_vcfgtcheck(int argc, char *argv[])
{
int c;
args_t *args = (args_t*) calloc(1,sizeof(args_t));
args->files = bcf_sr_init();
args->argc = argc; args->argv = argv; set_cwd(args);
char *regions = NULL, *targets = NULL;
int regions_is_file = 0, targets_is_file = 0;
// In simulated sample swaps the minimum error was 0.3 and maximum intra-sample error was 0.23
// - min_inter: pairs with smaller err value will be considered identical
// - max_intra: pairs with err value bigger than abs(max_intra_err) will be considered
// different. If negative, the cutoff may be heuristically lowered
args->min_inter_err = 0.23;
args->max_intra_err = -0.3;
static struct option loptions[] =
{
{"cluster",1,0,'c'},
{"GTs-only",1,0,'G'},
{"all-sites",0,0,'a'},
{"homs-only",0,0,'H'},
{"help",0,0,'h'},
{"genotypes",1,0,'g'},
{"plot",1,0,'p'},
{"target-sample",1,0,'S'},
{"query-sample",1,0,'s'},
{"regions",1,0,'r'},
{"regions-file",1,0,'R'},
{"targets",1,0,'t'},
{"targets-file",1,0,'T'},
{0,0,0,0}
};
char *tmp;
while ((c = getopt_long(argc, argv, "hg:p:s:S:Hr:R:at:T:G:c:",loptions,NULL)) >= 0) {
switch (c) {
case 'c':
args->min_inter_err = strtod(optarg,&tmp);
if ( *tmp )
{
if ( *tmp!=',') error("Could not parse: -c %s\n", optarg);
args->max_intra_err = strtod(tmp+1,&tmp);
if ( *tmp ) error("Could not parse: -c %s\n", optarg);
}
break;
case 'G':
args->no_PLs = strtol(optarg,&tmp,10);
if ( *tmp ) error("Could not parse argument: --GTs-only %s\n", optarg);
break;
case 'a': args->all_sites = 1; break;
case 'H': args->hom_only = 1; break;
case 'g': args->gt_fname = optarg; break;
case 'p': args->plot = optarg; break;
case 'S': args->target_sample = optarg; break;
case 's': args->query_sample = optarg; break;
case 'r': regions = optarg; break;
case 'R': regions = optarg; regions_is_file = 1; break;
case 't': targets = optarg; break;
case 'T': targets = optarg; targets_is_file = 1; break;
case 'h':
case '?': usage();
default: error("Unknown argument: %s\n", optarg);
}
}
char *fname = NULL;
if ( optind==argc )
{
if ( !isatty(fileno((FILE *)stdin)) ) fname = "-"; // reading from stdin
else usage(); // no files given
}
else fname = argv[optind];
if ( argc>optind+1 ) usage(); // too many files given
if ( !args->gt_fname ) args->cross_check = 1; // no genotype file, run in cross-check mode
else args->files->require_index = 1;
if ( regions && bcf_sr_set_regions(args->files, regions, regions_is_file)<0 ) error("Failed to read the regions: %s\n", regions);
if ( targets && bcf_sr_set_targets(args->files, targets, targets_is_file, 0)<0 ) error("Failed to read the targets: %s\n", targets);
if ( !bcf_sr_add_reader(args->files, fname) ) error("Failed to open %s: %s\n", fname,bcf_sr_strerror(args->files->errnum));
if ( args->gt_fname && !bcf_sr_add_reader(args->files, args->gt_fname) ) error("Failed to open %s: %s\n", args->gt_fname,bcf_sr_strerror(args->files->errnum));
args->files->collapse = COLLAPSE_SNPS|COLLAPSE_INDELS;
if ( args->plot ) args->plot = init_prefix(args->plot);
init_data(args);
if ( args->cross_check )
cross_check_gts(args);
else
check_gt(args);
destroy_data(args);
bcf_sr_destroy(args->files);
if (args->plot) free(args->plot);
free(args);
return 0;
}
|