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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
|
/* The MIT License
Copyright (c) 2019-2022 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 <stdlib.h>
#include <strings.h>
#include <getopt.h>
#include <unistd.h> // for isatty
#include <inttypes.h>
#include <htslib/hts.h>
#include <htslib/vcf.h>
#include <htslib/bgzf.h>
#include <htslib/kstring.h>
#include <htslib/kseq.h>
#include <htslib/synced_bcf_reader.h>
#include <htslib/khash_str2int.h>
#include <regex.h>
#include "../bcftools.h"
#include "../filter.h"
#include "../convert.h"
#include "../cols.h"
// Logic of the filters: include or exclude sites which match the filters?
#define FLT_INCLUDE 1
#define FLT_EXCLUDE 2
#define SELECT_TR_ALL 0
#define SELECT_TR_WORST 1
#define SELECT_TR_PRIMARY 2
#define SELECT_CSQ_ANY -1
typedef struct
{
regex_t *regex;
char *type;
}
col2type_t;
typedef struct
{
char *field; // the name of the VEP field, e.g. Consequence,Gene,etc.
char *tag; // the name of the VCF tag: the annot_t.field with the -p prefix
int idx; // 0-based index within the VEP annotation string
int type; // annotation type, one of the BCF_HT_* types
kstring_t str; // annotation value, ready to pass to bcf_update_info_*
}
annot_t;
typedef struct
{
convert_t *convert;
filter_t *filter;
int argc, filter_logic, regions_is_file, targets_is_file, list_hdr, record_cmd_line, clevel;
int regions_overlap, targets_overlap;
kstring_t kstr;
char *filter_str,
*vep_tag; // the --annotation INFO tag to process
char **argv, *output_fname, *fname, *regions, *targets, *format_str;
int output_type;
htsFile *fh_vcf;
BGZF *fh_bgzf;
bcf_srs_t *sr;
bcf_hdr_t *hdr, *hdr_out;
int nfield; // number of all available VEP fields
char **field; // list of all available VEP fields
int nannot; // number of requested fields
annot_t *annot; // requested fields
int nscale; // number of items in the severity scale
char **scale; // severity scale (list)
int ncsq_str; // the length of csq_str allocated by bcf_get_info_string()
char *csq_str; // the current bcf_get_info_string() result
int csq_idx, // the index of the Consequence field; for the --select CSQ option
primary_id; // the index of the CANONICAL field; for the --select TR option
char *severity, // the --severity scale option
*select, // the --select option
*column_str, // the --columns option
*column_types, // the --columns-types option
*annot_prefix; // the --annot-prefix option
void *field2idx, // VEP field name to index, used in initialization
*csq2severity; // consequence type to severity score
cols_t *cols_tr, // the current CSQ tag split into transcripts
*cols_csq; // the current CSQ transcript split into fields
int min_severity, max_severity; // ignore consequences outside this severity range
int drop_sites; // the -x, --drop-sites option
int select_tr; // one of SELECT_TR_*
uint8_t *smpl_pass; // for filtering at sample level, used with -f
int duplicate; // the -d, --duplicate option is set
char *all_fields_delim; // the -A, --all-fields option is set
float *farr; // helper arrays for bcf_update_* functions
int32_t *iarr;
int niarr,miarr, nfarr,mfarr;
col2type_t *column2type;
int ncolumn2type;
int raw_vep_request; // raw VEP tag requested and will need subsetting
int allow_undef_tags;
}
args_t;
args_t args;
const char *about(void)
{
return "Query structured annotations such as the CSQ created by VEP.\n";
}
static const char *default_severity(void)
{
return
"# Default consequence substrings ordered in ascending order by severity.\n"
"# Consequences with the same severity can be put on the same line in arbitrary order.\n"
"# See also https://m.ensembl.org/info/genome/variation/prediction/predicted_data.htm\n"
"intergenic\n"
"feature_truncation feature_elongation\n"
"regulatory\n"
"TF_binding_site TFBS\n"
"downstream upstream\n"
"non_coding_transcript non_coding\n"
"intron NMD_transcript\n"
"non_coding_transcript_exon\n"
"5_prime_utr 3_prime_utr\n"
"coding_sequence mature_miRNA\n"
"stop_retained start_retained synonymous\n"
"incomplete_terminal_codon\n"
"splice_region\n"
"missense inframe protein_altering\n"
"transcript_amplification\n"
"exon_loss\n"
"disruptive\n"
"start_lost stop_lost stop_gained frameshift\n"
"splice_acceptor splice_donor\n"
"transcript_ablation\n";
}
static const char *default_column_types(void)
{
return
"# Default CSQ subfield types, unlisted fields are type String.\n"
"# Note the use of regular expressions.\n"
"cDNA_position Integer\n"
"CDS_position Integer\n"
"Protein_position Integer\n"
"DISTANCE Integer\n"
"STRAND Integer\n"
"TSL Integer\n"
"GENE_PHENO Integer\n"
"HGVS_OFFSET Integer\n"
"AF Float\n"
".*_AF Float\n"
"MAX_AF_.* Float\n"
"MOTIF_POS Integer\n"
"MOTIF_SCORE_CHANGE Float\n"
"existing_InFrame_oORFs Integer\n"
"existing_OutOfFrame_oORFs Integer\n"
"existing_uORFs Integer\n"
"SpliceAI_pred_DP_.* Integer\n"
"SpliceAI_pred_DS_.* Float\n";
}
static const char *usage_text(void)
{
return
"\n"
"About: Query structured annotations such INFO/CSQ created by bcftools/csq or VEP. For more\n"
" more information and pointers see http://samtools.github.io/bcftools/howtos/plugin.split-vep.html\n"
"Usage: bcftools +split-vep [Plugin Options]\n"
"Plugin options:\n"
" -a, --annotation STR INFO annotation to parse [CSQ]\n"
" -A, --all-fields DELIM Output all fields replacing the -a tag (\"%CSQ\" by default) in the -f\n"
" filtering expression using the output field delimiter DELIM. This can be\n"
" \"tab\", \"space\" or an arbitrary string.\n"
" -c, --columns [LIST|-][:TYPE] Extract the fields listed either as 0-based indexes or names, \"-\" to extract all\n"
" fields. See --columns-types for the defaults. Supported types are String/Str,\n"
" Integer/Int and Float/Real. Unlisted fields are set to String.\n"
" --columns-types -|FILE Pass \"-\" to print the default -c types or FILE to override the presets\n"
" -d, --duplicate Output per transcript/allele consequences on a new line rather rather than\n"
" as comma-separated fields on a single line\n"
" -f, --format STR Create non-VCF output; similar to `bcftools query -f` but drops lines w/o consequence\n"
" -l, --list Parse the VCF header and list the annotation fields\n"
" -p, --annot-prefix STR Before doing anything else, prepend STR to all CSQ fields to avoid tag name conflicts\n"
" -s, --select TR:CSQ Select transcripts to extract by type and/or consequence severity. (See also -S and -x.)\n"
" TR, transcript: worst,primary(*),all [all]\n"
" CSQ, consequence: any,missense,missense+,etc [any]\n"
" (*) Primary transcripts have the field \"CANONICAL\" set to \"YES\"\n"
" -S, --severity -|FILE Pass \"-\" to print the default severity scale or FILE to override\n"
" the default scale\n"
" -u, --allow-undef-tags Print \".\" for undefined tags\n"
" -x, --drop-sites Drop sites with none of the consequences matching the severity specified by -s.\n"
" This switch is intended for use with VCF/BCF output (i.e. -f not given).\n"
"Common options:\n"
" -e, --exclude EXPR Exclude sites and samples for which the expression is true\n"
" -i, --include EXPR Include sites and samples for which the expression is true\n"
" --no-version Do not append version and command line to the header\n"
" -o, --output FILE Output file name [stdout]\n"
" -O, --output-type u|b|v|z[0-9] u/b: un/compressed BCF, v/z: un/compressed VCF, 0-9: compression level [v]\n"
" -r, --regions REG Restrict to comma-separated list of regions\n"
" -R, --regions-file FILE Restrict to regions listed in a file\n"
" --regions-overlap 0|1|2 Include if POS in the region (0), record overlaps (1), variant overlaps (2) [1]\n"
" -t, --targets REG Similar to -r but streams rather than index-jumps\n"
" -T, --targets-file FILE Similar to -R but streams rather than index-jumps\n"
" --targets-overlap 0|1|2 Include if POS in the region (0), record overlaps (1), variant overlaps (2) [0]\n"
"\n"
"Examples:\n"
" # List available fields of the INFO/CSQ annotation\n"
" bcftools +split-vep -l file.vcf.gz\n"
"\n"
" # List the default severity scale\n"
" bcftools +split-vep -S -\n"
"\n"
" # Extract Consequence, IMPACT and gene SYMBOL of the most severe consequence into\n"
" # INFO annotations starting with the prefix \"vep\". For brevity, the columns can\n"
" # be given also as 0-based indexes\n"
" bcftools +split-vep -c Consequence,IMPACT,SYMBOL -s worst -p vep file.vcf.gz\n"
" bcftools +split-vep -c 1-3 -s worst -p vep file.vcf.gz\n"
"\n"
" # Same as above but use the text output of the \"bcftools query\" format\n"
" bcftools +split-vep -s worst -f '%CHROM %POS %Consequence %IMPACT %SYMBOL\\n' file.vcf.gz\n"
"\n"
" # Print all subfields (tab-delimited) in place of %CSQ, each consequence on a new line\n"
" bcftools +split-vep -f '%CHROM %POS %CSQ\\n' -d -A tab file.vcf.gz\n"
"\n"
" # Extract gnomAD_AF subfield into a new INFO/gnomAD_AF annotation of Type=Float so that\n"
" # numeric filtering can be used.\n"
" bcftools +split-vep -c gnomAD_AF:Float file.vcf.gz -i'gnomAD_AF<0.001'\n"
"\n"
" # Similar to above, but add the annotation only if the consequence severity is missense\n"
" # or equivalent. In order to drop sites with different consequences completely, we add\n"
" # the -x switch. See the online documentation referenced above for more examples.\n"
" bcftools +split-vep -c gnomAD_AF:Float -s :missense file.vcf.gz\n"
" bcftools +split-vep -c gnomAD_AF:Float -s :missense -x file.vcf.gz\n"
"\n"
" See also http://samtools.github.io/bcftools/howtos/plugin.split-vep.html\n"
"\n";
}
static void expand_csq_expression(args_t *args, kstring_t *str)
{
if ( !args->all_fields_delim ) return;
str->l = 0;
kputc('%',str);
kputs(args->vep_tag,str);
char *ptr = strstr(args->format_str,str->s);
if ( !ptr ) return;
char *end = ptr + str->l, tmp = *end;
if ( isalnum(tmp) || tmp=='_' || tmp=='.' ) return;
*end = 0;
str->l = 0;
kputsn(args->format_str, ptr - args->format_str, str);
int i;
for (i=0; i<args->nfield; i++)
{
if ( i>0 ) kputs(args->all_fields_delim, str);
kputc('%', str);
kputs(args->field[i], str);
}
*end = tmp;
kputs(end, str);
free(args->format_str);
args->format_str = str->s;
str->l = str->m = 0;
str->s = NULL;
}
static void init_column2type(args_t *args)
{
int i, ntype = 0;
char **type = NULL;
if ( args->column_types && strcmp("-",args->column_types) )
type = hts_readlines(args->column_types, &ntype);
else
{
char *str = strdup(default_column_types());
char *beg = str;
while ( *beg )
{
char *end = beg;
while ( *end && *end!='\n' ) end++;
char tmp = *end;
*end = 0;
ntype++;
type = (char**) realloc(type,sizeof(*type)*ntype);
type[ntype-1] = strdup(beg);
if ( !tmp ) break;
beg = end+1;
}
free(str);
}
if ( !type || !ntype ) error("Failed to parse the column types\n");
for (i=0; i<ntype; i++)
{
if ( type[i][0]=='#' ) continue;
char *tmp = strdup(type[i]);
char *ptr = tmp;
while ( *ptr && !isspace(*ptr) ) ptr++;
if ( !*ptr ) error("Error: failed to parse the column type \"%s\"\n",type[i]);
*ptr = 0;
ptr++;
while ( *ptr && isspace(*ptr) ) ptr++;
if ( !*ptr ) error("Error: failed to parse the column type \"%s\"\n",type[i]);
args->ncolumn2type++;
args->column2type = (col2type_t*) realloc(args->column2type,sizeof(*args->column2type)*args->ncolumn2type);
col2type_t *ct = &args->column2type[args->ncolumn2type-1];
ct->regex = (regex_t *) malloc(sizeof(regex_t));
if ( regcomp(ct->regex, tmp, REG_NOSUB) )
error("Error: fail to compile the column type regular expression \"%s\": %s\n", tmp,type[i]);
int type_ok = 0;
if ( !strcmp(ptr,"Float") ) type_ok = 1;
else if ( !strcmp(ptr,"Integer") ) type_ok = 1;
else if ( !strcmp(ptr,"Flag") ) type_ok = 1;
else if ( !strcmp(ptr,"String") ) type_ok = 1;
if ( !type_ok ) error("Error: the column type \"%s\" is not supported: %s\n",ptr,type[i]);
ct->type = strdup(ptr);
free(tmp);
}
if ( !args->ncolumn2type ) error("Failed to parse the column types\n");
for (i=0; i<ntype; i++) free(type[i]);
free(type);
}
static void destroy_column2type(args_t *args)
{
int i;
for (i=0; i<args->ncolumn2type; i++)
{
regfree(args->column2type[i].regex);
free(args->column2type[i].regex);
free(args->column2type[i].type);
}
free(args->column2type);
}
static const char *get_column_type(args_t *args, char *field)
{
if ( !args->column2type ) init_column2type(args);
int i;
for (i=0; i<args->ncolumn2type; i++)
{
int match = regexec(args->column2type[i].regex, field, 0,NULL,0) ? 0 : 1;
if ( match ) return args->column2type[i].type;
}
return "String";
}
static int query_has_field(char *fmt, char *field, kstring_t *str)
{
str->l = 0;
kputc('%',str);
kputs(field,str);
char end, *ptr = fmt;
while ( ptr )
{
ptr = strstr(ptr,str->s);
if ( !ptr ) return 0;
end = ptr[str->l];
if ( isalnum(end) || end=='_' || end=='.' )
{
ptr++;
continue;
}
break;
}
return 1;
}
/**
The valid_tag array was generated with
perl -le '@v = (split(//,q[_.]),"a"..."z","A"..."Z","0"..."9"); @a = (0) x 256; foreach $c (@v) { $a[ord($c)] = 1; } print join(", ",@a)' | fold -w 48
*/
static const uint8_t valid_tag[256] =
{
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0,
0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1,
0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
};
static void sanitize_field_name(char *fmt)
{
while ( *fmt )
{
if ( !valid_tag[(uint8_t)*fmt] ) *fmt = '_';
fmt++;
}
}
char *strdup_annot_prefix(args_t *args, const char *str)
{
char *out;
if ( !args->annot_prefix )
{
out = strdup(str);
sanitize_field_name(out);
return out;
}
int str_len = strlen(str);
int prefix_len = strlen(args->annot_prefix);
out = calloc(str_len+prefix_len+1,1);
memcpy(out,args->annot_prefix,prefix_len);
memcpy(out+prefix_len,str,str_len);
sanitize_field_name(out);
return out;
}
static void init_data(args_t *args)
{
args->sr = bcf_sr_init();
if ( args->regions )
{
args->sr->require_index = 1;
bcf_sr_set_opt(args->sr,BCF_SR_REGIONS_OVERLAP,args->regions_overlap);
if ( bcf_sr_set_regions(args->sr, args->regions, args->regions_is_file)<0 ) error("Failed to read the regions: %s\n",args->regions);
}
if ( args->targets )
{
bcf_sr_set_opt(args->sr,BCF_SR_TARGETS_OVERLAP,args->targets_overlap);
if ( bcf_sr_set_targets(args->sr, args->targets, args->targets_is_file, 0)<0 ) error("Failed to read the targets: %s\n",args->targets);
}
if ( !bcf_sr_add_reader(args->sr,args->fname) ) error("Error: %s\n", bcf_sr_strerror(args->sr->errnum));
args->hdr = bcf_sr_get_header(args->sr,0);
args->hdr_out = bcf_hdr_dup(args->hdr);
// Parse the header CSQ line, must contain Description with "Format: ..." declaration
bcf_hrec_t *hrec = bcf_hdr_get_hrec(args->hdr, BCF_HL_INFO, NULL, args->vep_tag, NULL);
if ( !hrec ) error("The tag INFO/%s not found in the header\n", args->vep_tag);
int ret = bcf_hrec_find_key(hrec, "Description");
if ( ret<0 ) error("No \"Description\" field was found for the tag INFO/%s in the header\n", args->vep_tag);
char *format = strstr(hrec->vals[ret], "Format: ");
if ( !format ) error("Expected \"Format: \" substring in the header INFO/%s/Description, found: %s\n", args->vep_tag,hrec->vals[ret]);
format += 8;
char *ep = format;
while ( *ep )
{
char *bp = ep;
while ( *ep && *ep!='|' && *ep!='"' && *ep!='(' ) ep++; // don't include bracket in "pos(1-based)"
char tmp = *ep;
*ep = 0;
args->nfield++;
args->field = (char**)realloc(args->field,args->nfield*sizeof(*args->field));
args->field[args->nfield-1] = strdup_annot_prefix(args,bp);
if ( !tmp ) break;
*ep = tmp;
while ( *ep && *ep!='|' ) ep++; // skip bracket in "pos(1-based)"
if ( *ep ) ep++;
}
if ( !args->nfield ) error("Could not parse Description of INFO/%s: %s\n", args->vep_tag,hrec->vals[ret]);
args->field2idx = khash_str2int_init();
int i,j;
for (i=0; i<args->nfield; i++)
{
if ( khash_str2int_has_key(args->field2idx, args->field[i]) )
{
fprintf(stderr,"Warning: duplicate INFO/%s key \"%s\"\n", args->vep_tag,args->field[i]);
continue;
}
khash_str2int_set(args->field2idx, args->field[i], i);
}
// Severity scale
kstring_t str = {0,0,0};
args->csq2severity = khash_str2int_init();
int severity = 0;
if ( args->severity )
{
kstring_t tmp = {0,0,0};
htsFile *fp = hts_open(args->severity,"r");
if ( !fp ) error("Cannot read %s\n", args->severity);
while ( hts_getline(fp, KS_SEP_LINE, &tmp) > 0 )
{
kputs(tmp.s, &str);
kputc('\n', &str);
}
free(tmp.s);
}
else
kputs(default_severity(),&str);
ep = str.s;
while ( *ep )
{
if ( *ep=='#' )
{
while ( *ep && *ep!='\n' ) { *ep = tolower(*ep); ep++; }
if ( !*ep ) break;
ep++;
continue;
}
char *bp = ep;
while ( *ep && !isspace(*ep) ) { *ep = tolower(*ep); ep++; }
char tmp = *ep;
*ep = 0;
args->nscale++;
args->scale = (char**) realloc(args->scale,args->nscale*sizeof(*args->scale));
args->scale[args->nscale-1] = strdup(bp);
if ( !khash_str2int_has_key(args->csq2severity,args->scale[args->nscale-1]) )
khash_str2int_set(args->csq2severity,args->scale[args->nscale-1], severity);
if ( !tmp ) break;
if ( tmp=='\n' ) severity++;
ep++;
while ( *ep && isspace(*ep) ) ep++;
}
// Transcript and/or consequence selection
if ( !args->select ) args->select = "all:any";
cols_t *cols = cols_split(args->select, NULL, ':');
char *sel_tr = cols->off[0][0] ? cols->off[0] : "all";
char *sel_csq = cols->n==2 && cols->off[1][0] ? cols->off[1] : "any";
if ( !strcasecmp(sel_tr,"all") ) args->select_tr = SELECT_TR_ALL;
else if ( !strcasecmp(sel_tr,"worst") ) args->select_tr = SELECT_TR_WORST;
else if ( !strcasecmp(sel_tr,"primary") ) args->select_tr = SELECT_TR_PRIMARY;
else error("Error: the transcript selection key \"%s\" is not recognised.\n", sel_tr);
if ( !strcasecmp(sel_csq,"any") ) { args->min_severity = args->max_severity = SELECT_CSQ_ANY; } // to avoid unnecessary lookups
else
{
int len = strlen(sel_csq);
int severity, modifier = '=';
if ( sel_csq[len-1]=='+' ) { modifier = '+'; sel_csq[len-1] = 0; }
else if ( sel_csq[len-1]=='-' ) { modifier = '-'; sel_csq[len-1] = 0; }
if ( khash_str2int_get(args->csq2severity, sel_csq, &severity)!=0 )
error("Error: the consequence \"%s\" is not recognised. Run \"bcftools +split-vep -S ?\" to see the default list.\n", sel_csq);
if ( modifier=='=' ) { args->min_severity = severity; args->max_severity = severity; }
else if ( modifier=='+' ) { args->min_severity = severity; args->max_severity = INT_MAX; }
else if ( modifier=='-' ) { args->min_severity = 0; args->max_severity = severity; }
}
cols_destroy(cols);
// The 'CANONICAL' column to look up severity, its name is hardwired for now
if ( args->select_tr==SELECT_TR_PRIMARY )
{
char *tmp = strdup_annot_prefix(args,"CANONICAL");
if ( khash_str2int_get(args->field2idx,tmp,&args->primary_id)!=0 )
error("The primary transcript was requested but the field \"CANONICAL\" is not present in INFO/%s: %s\n",args->vep_tag,hrec->vals[ret]);
free(tmp);
}
// Create a text output as with `bcftools query -f`. For this we need to determine the fields to be extracted
// from the formatting expression
if ( args->format_str && !args->column_str )
{
// Special case: -A was given, extract all fields, for this the -a tag (%CSQ) must be present
if ( args->all_fields_delim ) expand_csq_expression(args, &str);
for (i=0; i<args->nfield; i++)
{
if ( !query_has_field(args->format_str,args->field[i],&str) ) continue;
int tag_id = bcf_hdr_id2int(args->hdr, BCF_DT_ID, args->field[i]);
if ( bcf_hdr_idinfo_exists(args->hdr,BCF_HL_INFO,tag_id) )
fprintf(stderr,"Note: ambiguous key %%%s; using the %s subfield of %s, not the INFO/%s tag\n", args->field[i],args->field[i],args->vep_tag,args->field[i]);
int olen = args->column_str ? strlen(args->column_str) : 0;
int nlen = strlen(args->field[i]);
args->column_str = (char*)realloc(args->column_str, olen + nlen + 2);
if ( olen )
{
memcpy(args->column_str+olen,",",1);
olen++;
}
memcpy(args->column_str+olen,args->field[i],nlen);
args->column_str[olen+nlen] = 0;
}
if ( query_has_field(args->format_str,args->vep_tag,&str) ) args->raw_vep_request = 1;
}
// The "Consequence" column to look up severity, its name is hardwired for now
char *tmp = strdup_annot_prefix(args,"Consequence");
if ( khash_str2int_get(args->field2idx,tmp,&args->csq_idx)!=0 )
error("The field \"Consequence\" is not present in INFO/%s: %s\n", args->vep_tag,hrec->vals[ret]);
free(tmp);
// Columns to extract: given as names, 0-based indexes or ranges of indexes
if ( args->column_str )
{
int *column = NULL;
int *types = NULL;
if ( !strcmp("-",args->column_str) ) // all subfields
{
free(args->column_str);
kstring_t str = {0,0,0};
ksprintf(&str,"0-%d",args->nfield-1);
args->column_str = str.s;
}
ep = args->column_str;
while ( *ep )
{
char *tp, *bp = ep;
while ( *ep && *ep!=',' ) ep++;
char keep = *ep;
*ep = 0;
int type = -1;
int idx_beg, idx_end;
if ( !strcmp("-",bp) )
{
kstring_t str = {0,0,0};
ksprintf(&str,"0-%d",args->nfield-1);
if ( keep ) ksprintf(&str,",%s",ep+1);
free(args->column_str);
args->column_str = str.s;
ep = str.s;
continue;
}
char *tmp = strdup_annot_prefix(args, bp);
if ( khash_str2int_get(args->field2idx, bp, &idx_beg)==0 || khash_str2int_get(args->field2idx, tmp, &idx_beg)==0 )
idx_end = idx_beg;
else if ( (tp=strrchr(bp,':')) )
{
*tp = 0;
if ( khash_str2int_get(args->field2idx, bp, &idx_beg)!=0 )
{
*tp = ':';
tp = strrchr(tmp,':');
*tp = 0;
if ( khash_str2int_get(args->field2idx, tmp, &idx_beg)!=0 ) error("No such column: \"%s\"\n", bp);
}
idx_end = idx_beg;
*tp = ':';
if ( !strcasecmp(tp+1,"string") ) type = BCF_HT_STR;
else if ( !strcasecmp(tp+1,"float") || !strcasecmp(tp+1,"real") ) type = BCF_HT_REAL;
else if ( !strcasecmp(tp+1,"integer") || !strcasecmp(tp+1,"int") ) type = BCF_HT_INT;
else if ( !strcasecmp(tp+1,"flag") ) type = BCF_HT_FLAG;
else error("The type \"%s\" (or column \"%s\"?) not recognised\n", tp+1,bp);
}
else
{
char *mp;
idx_beg = strtol(bp,&mp,10);
if ( !*mp ) idx_end = idx_beg;
else if ( *mp=='-' )
idx_end = strtol(mp+1,&mp,10);
if ( *mp )
{
if ( *mp==':' )
{
idx_end = idx_beg;
if ( !strcasecmp(mp+1,"string") ) type = BCF_HT_STR;
else if ( !strcasecmp(mp+1,"float") || !strcasecmp(mp+1,"real") ) type = BCF_HT_REAL;
else if ( !strcasecmp(mp+1,"integer") || !strcasecmp(mp+1,"int") ) type = BCF_HT_INT;
else if ( !strcasecmp(mp+1,"flag") ) type = BCF_HT_FLAG;
else error("The type \"%s\" (or column \"%s\"?) not recognised\n", mp+1,bp);
}
else if ( !strcmp(bp,args->vep_tag) )
{
free(tmp);
args->raw_vep_request = 1;
if ( !keep ) break;
ep++;
continue;
}
else
error("No such column: \"%s\"\n", bp);
}
}
free(tmp);
i = args->nannot;
args->nannot += idx_end - idx_beg + 1;
column = (int*)realloc(column,args->nannot*sizeof(*column));
types = (int*)realloc(types,args->nannot*sizeof(*types));
for (j=idx_beg; j<=idx_end; j++)
{
if ( j >= args->nfield ) error("The index is too big: %d\n", j);
column[i] = j;
types[i] = type;
i++;
}
if ( !keep ) break;
ep++;
}
args->annot = (annot_t*)calloc(args->nannot,sizeof(*args->annot));
for (i=0; i<args->nannot; i++)
{
annot_t *ann = &args->annot[i];
ann->type = types[i];
ann->idx = j = column[i];
ann->field = strdup(args->field[j]);
ann->tag = strdup(args->field[j]);
args->kstr.l = 0;
const char *type = "String";
if ( ann->type==BCF_HT_REAL ) type = "Float";
else if ( ann->type==BCF_HT_INT ) type = "Integer";
else if ( ann->type==BCF_HT_FLAG ) type = "Flag";
else if ( ann->type==BCF_HT_STR ) type = "String";
else if ( ann->type==-1 ) type = get_column_type(args, args->field[j]);
ksprintf(&args->kstr,"##INFO=<ID=%%s,Number=.,Type=%s,Description=\"The %%s field from INFO/%%s\">",type);
bcf_hdr_printf(args->hdr_out, args->kstr.s, ann->tag,ann->field,args->vep_tag);
}
if ( args->raw_vep_request && args->select_tr==SELECT_TR_ALL ) args->raw_vep_request = 0;
if ( args->raw_vep_request )
{
args->nannot++;
args->annot = (annot_t*)realloc(args->annot,args->nannot*sizeof(*args->annot));
annot_t *ann = &args->annot[args->nannot-1];
ann->type = BCF_HT_STR;
ann->idx = -1;
ann->field = strdup(args->vep_tag);
ann->tag = strdup(args->vep_tag);
memset(&ann->str,0,sizeof(ann->str));
}
free(column);
free(types);
destroy_column2type(args);
if ( bcf_hdr_sync(args->hdr_out)<0 )
error_errno("[%s] Failed to update header", __func__);
}
if ( args->format_str )
{
if ( !args->column_str && !args->select ) error("Error: No %s field selected in the formatting expression and -s not given: a typo?\n",args->vep_tag);
args->convert = convert_init(args->hdr_out, NULL, 0, args->format_str);
if ( !args->convert ) error("Could not parse the expression: %s\n", args->format_str);
if ( args->allow_undef_tags ) convert_set_option(args->convert, allow_undef_tags, 1);
}
if ( args->filter_str )
{
int max_unpack = args->convert ? convert_max_unpack(args->convert) : 0;
args->filter = filter_init(args->hdr_out, args->filter_str);
max_unpack |= filter_max_unpack(args->filter);
if ( !args->format_str ) max_unpack |= BCF_UN_FMT; // don't drop FMT fields on VCF input when VCF/BCF is output
args->sr->max_unpack = max_unpack;
if ( args->convert && (max_unpack & BCF_UN_FMT) )
convert_set_option(args->convert, subset_samples, &args->smpl_pass);
}
free(str.s);
}
static void destroy_data(args_t *args)
{
free(args->farr);
free(args->iarr);
free(args->kstr.s);
free(args->column_str);
free(args->format_str);
cols_destroy(args->cols_csq);
cols_destroy(args->cols_tr);
int i;
for (i=0; i<args->nscale; i++) free(args->scale[i]);
free(args->scale);
for (i=0; i<args->nfield; i++) free(args->field[i]);
free(args->field);
for (i=0; i<args->nannot; i++)
{
annot_t *ann = &args->annot[i];
free(ann->field);
free(ann->tag);
free(ann->str.s);
}
free(args->annot);
if ( args->field2idx ) khash_str2int_destroy(args->field2idx);
if ( args->csq2severity ) khash_str2int_destroy(args->csq2severity);
bcf_sr_destroy(args->sr);
bcf_hdr_destroy(args->hdr_out);
free(args->csq_str);
if ( args->filter ) filter_destroy(args->filter);
if ( args->convert ) convert_destroy(args->convert);
if ( args->fh_vcf && hts_close(args->fh_vcf)!=0 ) error("Error: close failed .. %s\n",args->output_fname);
if ( args->fh_bgzf && bgzf_close(args->fh_bgzf)!=0 ) error("Error: close failed .. %s\n",args->output_fname);
free(args);
}
static void list_header(args_t *args)
{
int i;
for (i=0; i<args->nfield; i++) printf("%d\t%s\n", i,args->field[i]);
}
static void csq_to_severity(args_t *args, char *csq, int *min_severity, int *max_severity, int exact_match)
{
*min_severity = INT_MAX;
*max_severity = -1;
char *ep = csq;
while ( *ep )
{
char *bp = ep;
while ( *ep && *ep!='&' ) { *ep = tolower(*ep); ep++; }
char tmp = *ep;
*ep = 0;
int i, severity = -1;
if ( khash_str2int_get(args->csq2severity, bp, &severity)!=0 )
{
for (i=0; i<args->nscale; i++)
if ( strstr(bp,args->scale[i]) ) break;
if ( i!=args->nscale )
khash_str2int_get(args->csq2severity, args->scale[i], &severity);
else
severity = args->nscale + 1;
args->nscale++;
args->scale = (char**) realloc(args->scale,args->nscale*sizeof(*args->scale));
args->scale[args->nscale-1] = strdup(bp);
khash_str2int_set(args->csq2severity,args->scale[args->nscale-1], severity);
if ( i==args->nscale )
fprintf(stderr,"Note: assigning a (high) severity score to a new consequence, use -S to override: %s -> %d\n",args->scale[args->nscale-1],args->nscale);
if ( khash_str2int_get(args->csq2severity, bp, &severity)!=0 ) error("FIXME: failed to look up the consequence \"%s\"\n", bp);
}
if ( exact_match < 0 )
{
if ( *min_severity > severity ) *min_severity = severity;
if ( *max_severity < severity ) *max_severity = severity;
}
else
{
if ( severity==exact_match )
{
*min_severity = *max_severity = severity;
*ep = tmp;
return;
}
}
if ( !tmp ) break;
*ep = tmp;
ep++;
}
}
static int csq_severity_pass(args_t *args, char *csq)
{
if ( args->min_severity==args->max_severity && args->min_severity==SELECT_CSQ_ANY ) return 1;
int min_severity, max_severity, exact_match = args->min_severity==args->max_severity ? args->min_severity : -1;
csq_to_severity(args, csq, &min_severity, &max_severity, exact_match);
if ( max_severity < args->min_severity ) return 0;
if ( min_severity > args->max_severity ) return 0;
return 1;
}
static int get_primary_transcript(args_t *args, bcf1_t *rec, cols_t *cols_tr) // modifies args->cols_csq!
{
int i;
for (i=0; i<cols_tr->n; i++)
{
args->cols_csq = cols_split(cols_tr->off[i], args->cols_csq, '|');
if ( args->primary_id >= args->cols_csq->n )
error("Too few columns at %s:%"PRId64" .. %d (Consequence) >= %d\n", bcf_seqname(args->hdr,rec),(int64_t) rec->pos+1,args->primary_id,args->cols_csq->n);
if ( !strcmp("YES",args->cols_csq->off[args->primary_id]) ) return i;
}
return -1;
}
static int get_worst_transcript(args_t *args, bcf1_t *rec, cols_t *cols_tr) // modifies args->cols_csq!
{
int i, max_severity = -1, imax_severity = 0;
for (i=0; i<cols_tr->n; i++)
{
args->cols_csq = cols_split(cols_tr->off[i], args->cols_csq, '|');
if ( args->csq_idx >= args->cols_csq->n )
error("Too few columns at %s:%"PRId64" .. %d (Consequence) >= %d\n", bcf_seqname(args->hdr,rec),(int64_t) rec->pos+1,args->csq_idx,args->cols_csq->n);
char *csq = args->cols_csq->off[args->csq_idx];
int min, max;
csq_to_severity(args, csq, &min, &max, -1);
if ( max_severity < max ) { imax_severity = i; max_severity = max; }
}
return imax_severity;
}
static void annot_reset(annot_t *annot, int nannot)
{
int i;
for (i=0; i<nannot; i++) annot[i].str.l = 0;
}
static void annot_append(annot_t *ann, char *value)
{
if ( ann->str.l ) kputc(',',&ann->str);
kputs(value, &ann->str);
}
static inline void parse_array_real(char *str, float **arr, int *marr, int *narr)
{
char *bp = str, *ep;
float *ptr = *arr;
int i, n = 1, m = *marr;
for (i=0; *bp; bp++)
if ( *bp == ',' ) n++;
hts_expand(float*,n,m,ptr);
i = 0;
bp = str;
while ( *bp )
{
ptr[i] = strtod(bp, &ep);
if ( bp==ep )
bcf_float_set_missing(ptr[i]);
i++;
while ( *ep && *ep!=',' ) ep++;
bp = *ep ? ep + 1 : ep;
}
*narr = i;
*marr = m;
*arr = ptr;
}
static inline void parse_array_int32(char *str, int **arr, int *marr, int *narr)
{
char *bp = str, *ep;
int32_t *ptr = *arr;
int i, n = 1, m = *marr;
for (i=0; *bp; bp++)
if ( *bp == ',' ) n++;
hts_expand(int32_t*,n,m,ptr);
i = 0;
bp = str;
while ( *bp )
{
ptr[i] = strtol(bp, &ep, 10);
if ( bp==ep )
ptr[i] = bcf_int32_missing;
i++;
while ( *ep && *ep!=',' ) ep++;
bp = *ep ? ep + 1 : ep;
}
*narr = i;
*marr = m;
*arr = ptr;
}
static void filter_and_output(args_t *args, bcf1_t *rec, int severity_pass, int all_missing)
{
int i, updated = 0;
for (i=0; i<args->nannot; i++)
{
annot_t *ann = &args->annot[i];
if ( !ann->str.l ) continue;
if ( ann->type==BCF_HT_REAL )
{
parse_array_real(ann->str.s,&args->farr,&args->mfarr,&args->nfarr);
bcf_update_info_float(args->hdr_out,rec,ann->tag,args->farr,args->nfarr);
}
else if ( ann->type==BCF_HT_INT )
{
parse_array_int32(ann->str.s,&args->iarr,&args->miarr,&args->niarr);
bcf_update_info_int32(args->hdr_out,rec,ann->tag,args->iarr,args->niarr);
}
else
bcf_update_info_string(args->hdr_out,rec,ann->tag,ann->str.s);
updated++;
}
if ( args->filter )
{
int pass = filter_test(args->filter, rec, (const uint8_t**) &args->smpl_pass);
if ( args->filter_logic & FLT_EXCLUDE ) pass = pass ? 0 : 1;
if ( !pass ) return;
}
if ( args->format_str )
{
if ( args->nannot )
{
if ( !updated || all_missing ) return; // the standard case: using -f to print the CSQ subfields, skipping if missing
}
else
{
if ( !severity_pass ) return; // request to print only non-CSQ tags at sites that pass severity
}
args->kstr.l = 0;
convert_line(args->convert, rec, &args->kstr);
if ( args->kstr.l && bgzf_write(args->fh_bgzf, args->kstr.s, args->kstr.l)!=args->kstr.l )
error("Failed to write to %s\n", args->output_fname);
return;
}
if ( bcf_write(args->fh_vcf, args->hdr_out,rec)!=0 )
error("Failed to write to %s\n", args->output_fname);
}
static void process_record(args_t *args, bcf1_t *rec)
{
int len = bcf_get_info_string(args->hdr,rec,args->vep_tag,&args->csq_str,&args->ncsq_str);
if ( len<=0 )
{
if ( !args->drop_sites )
{
annot_reset(args->annot, args->nannot);
filter_and_output(args,rec,1,1);
}
return;
}
args->cols_tr = cols_split(args->csq_str, args->cols_tr, ',');
int i,j, itr_min = 0, itr_max = args->cols_tr->n - 1;
if ( args->select_tr==SELECT_TR_PRIMARY )
{
itr_min = itr_max = get_primary_transcript(args, rec, args->cols_tr);
if ( itr_min<0 ) itr_max = itr_min - 1;
}
else if ( args->select_tr==SELECT_TR_WORST )
itr_min = itr_max = get_worst_transcript(args, rec, args->cols_tr);
annot_reset(args->annot, args->nannot);
int severity_pass = 0; // consequence severity requested via the -s option (BCF record may be output but not annotated)
int all_missing = 1; // transcripts with all requested annotations missing will be discarded if -f was given
static int too_few_fields_warned = 0;
for (i=itr_min; i<=itr_max; i++)
{
args->cols_csq = cols_split(args->cols_tr->off[i], args->cols_csq, '|');
if ( args->csq_idx >= args->cols_csq->n )
error("Too few columns at %s:%"PRId64" .. %d (Consequence) >= %d\n", bcf_seqname(args->hdr,rec),(int64_t) rec->pos+1,args->csq_idx,args->cols_csq->n);
char *csq = args->cols_csq->off[args->csq_idx];
if ( !csq_severity_pass(args, csq) ) continue;
severity_pass = 1;
for (j=0; j<args->nannot; j++)
{
annot_t *ann = &args->annot[j];
if ( ann->idx >= args->cols_csq->n )
{
if ( !too_few_fields_warned )
{
fprintf(stderr, "Warning: fewer %s fields than expected at %s:%"PRId64", filling with dots. This warning is printed only once.\n", args->vep_tag,bcf_seqname(args->hdr,rec),(int64_t) rec->pos+1);
too_few_fields_warned = 1;
}
annot_append(ann, ".");
continue;
}
char *ann_str = NULL;
if ( ann->idx==-1 ) ann_str = args->cols_tr->off[i];
else if ( *args->cols_csq->off[ann->idx] ) ann_str = args->cols_csq->off[ann->idx];
if ( ann_str )
{
annot_append(ann, ann_str);
all_missing = 0;
}
else
annot_append(ann, "."); // missing value
}
if ( args->duplicate )
{
filter_and_output(args, rec, severity_pass, all_missing);
annot_reset(args->annot, args->nannot);
all_missing = 1;
severity_pass = 0;
}
}
if ( !severity_pass && args->drop_sites ) return;
if ( !args->duplicate )
filter_and_output(args, rec, severity_pass, all_missing);
}
int run(int argc, char **argv)
{
args_t *args = (args_t*) calloc(1,sizeof(args_t));
args->argc = argc; args->argv = argv;
args->output_fname = "-";
args->output_type = FT_VCF;
args->vep_tag = "CSQ";
args->record_cmd_line = 1;
args->regions_overlap = 1;
args->targets_overlap = 0;
args->clevel = -1;
static struct option loptions[] =
{
{"drop-sites",no_argument,0,'x'},
{"all-fields",no_argument,0,'A'},
{"duplicate",no_argument,0,'d'},
{"format",required_argument,0,'f'},
{"annotation",required_argument,0,'a'},
{"annot-prefix",required_argument,0,'p'},
{"columns",required_argument,0,'c'},
{"columns-types",required_argument,0,1},
{"select",required_argument,0,'s'},
{"severity",required_argument,0,'S'},
{"list",no_argument,0,'l'},
{"include",required_argument,0,'i'},
{"exclude",required_argument,0,'e'},
{"output",required_argument,NULL,'o'},
{"output-type",required_argument,NULL,'O'},
{"regions",1,0,'r'},
{"regions-file",1,0,'R'},
{"regions-overlap",required_argument,NULL,3},
{"targets",1,0,'t'},
{"targets-file",1,0,'T'},
{"targets-overlap",required_argument,NULL,4},
{"no-version",no_argument,NULL,2},
{"allow-undef-tags",no_argument,0,'u'},
{NULL,0,NULL,0}
};
int c;
char *tmp;
while ((c = getopt_long(argc, argv, "o:O:i:e:r:R:t:T:lS:s:c:p:a:f:dA:xu",loptions,NULL)) >= 0)
{
switch (c)
{
case 2 : args->record_cmd_line = 0; break;
case 1 : args->column_types = optarg; break;
case 'A':
if ( !strcasecmp(optarg,"tab") ) args->all_fields_delim = "\t";
else if ( !strcasecmp(optarg,"space") ) args->all_fields_delim = " ";
else args->all_fields_delim = optarg;
break;
case 'x': args->drop_sites = 1; break;
case 'd': args->duplicate = 1; break;
case 'f': args->format_str = strdup(optarg); break;
case 'a': args->vep_tag = optarg; break;
case 'p': args->annot_prefix = optarg; break;
case 'c': args->column_str = strdup(optarg); break;
case 'S': args->severity = optarg; break;
case 's': args->select = optarg; break;
case 'l': args->list_hdr = 1; break;
case 'u': args->allow_undef_tags = 1; break;
case 'e':
if ( args->filter_str ) error("Error: only one -i or -e expression can be given, and they cannot be combined\n");
args->filter_str = optarg; args->filter_logic |= FLT_EXCLUDE; break;
case 'i':
if ( args->filter_str ) error("Error: only one -i or -e expression can be given, and they cannot be combined\n");
args->filter_str = optarg; args->filter_logic |= FLT_INCLUDE; break;
case 't': args->targets = optarg; break;
case 'T': args->targets = optarg; args->targets_is_file = 1; break;
case 'r': args->regions = optarg; break;
case 'R': args->regions = optarg; args->regions_is_file = 1; break;
case 'o': args->output_fname = optarg; break;
case 'O':
switch (optarg[0]) {
case 'b': args->output_type = FT_BCF_GZ; break;
case 'u': args->output_type = FT_BCF; break;
case 'z': args->output_type = FT_VCF_GZ; break;
case 'v': args->output_type = FT_VCF; break;
default:
{
args->clevel = strtol(optarg,&tmp,10);
if ( *tmp || args->clevel<0 || args->clevel>9 ) error("The output type \"%s\" not recognised\n", optarg);
}
}
if ( optarg[1] )
{
args->clevel = strtol(optarg+1,&tmp,10);
if ( *tmp || args->clevel<0 || args->clevel>9 ) error("Could not parse argument: --compression-level %s\n", optarg+1);
}
break;
case 3 :
args->regions_overlap = parse_overlap_option(optarg);
if ( args->regions_overlap < 0 ) error("Could not parse: --regions-overlap %s\n",optarg);
break;
case 4 :
args->targets_overlap = parse_overlap_option(optarg);
if ( args->targets_overlap < 0 ) error("Could not parse: --targets-overlap %s\n",optarg);
break;
case 'h':
case '?':
default: error("%s", usage_text()); break;
}
}
if ( args->drop_sites && args->format_str ) error("Error: the -x behavior is the default (and only supported) with -f\n");
if ( args->all_fields_delim && !args->format_str ) error("Error: the -A option must be used with -f\n");
if ( args->severity && (!strcmp("?",args->severity) || !strcmp("-",args->severity)) ) error("%s", default_severity());
if ( args->column_types && !strcmp("-",args->column_types) ) error("%s", default_column_types());
if ( optind==argc )
{
if ( !isatty(fileno((FILE *)stdin)) ) args->fname = "-"; // reading from stdin
else { error("%s", usage_text()); }
}
else if ( optind+1!=argc ) error("%s", usage_text());
else args->fname = argv[optind];
init_data(args);
if ( args->list_hdr )
list_header(args);
else
{
if ( !args->format_str && !args->column_str )
{
if ( args->min_severity==SELECT_CSQ_ANY && args->max_severity==SELECT_CSQ_ANY )
error("Error: none of the -c,-f,-s options was given, why not use \"bcftools view\" instead?\n");
else if ( !args->drop_sites )
error("Error: when the -s option is used without -x, everything is printed; why not use \"bcftools view\" instead?\n");
}
if ( args->format_str )
args->fh_bgzf = bgzf_open(args->output_fname, args->output_type&FT_GZ ? "wg" : "wu");
else
{
char wmode[8];
set_wmode(wmode,args->output_type,args->output_fname,args->clevel);
args->fh_vcf = hts_open(args->output_fname ? args->output_fname : "-", wmode);
if ( args->record_cmd_line ) bcf_hdr_append_version(args->hdr_out, args->argc, args->argv, "bcftools_split-vep");
if ( bcf_hdr_write(args->fh_vcf, args->hdr_out)!=0 ) error("Failed to write the header to %s\n", args->output_fname);
}
while ( bcf_sr_next_line(args->sr) )
process_record(args, bcf_sr_get_line(args->sr,0));
}
destroy_data(args);
return 0;
}
|