/
G2P.pm
1379 lines (1226 loc) · 51.4 KB
/
G2P.pm
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
=head1 LICENSE
Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
Copyright [2016-2019] EMBL-European Bioinformatics Institute
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=head1 CONTACT
Ensembl <http://www.ensembl.org/info/about/contact/index.html>
=cut
=head1 NAME
G2P
=head1 SYNOPSIS
mv G2P.pm ~/.vep/Plugins
./vep -i variations.vcf --plugin G2P,file=/path/to/G2P.csv
=head1 DESCRIPTION
A VEP plugin that uses G2P allelic requirements to assess variants in genes
for potential phenotype involvement.
The plugin has multiple configuration options, though minimally requires only
the CSV file of G2P data.
Options are passed to the plugin as key=value pairs, (defaults in parentheses):
file : Path to G2P data file. The file needs to be uncompressed.
- Download from http://www.ebi.ac.uk/gene2phenotype/downloads
- Download from PanelApp
af_monoallelic : maximum allele frequency for inclusion for monoallelic genes (0.0001)
af_biallelic : maximum allele frequency for inclusion for biallelic genes (0.005)
confidence_levels : Confidence levels to include: confirmed, probable, possible, both RD and IF.
Separate multiple values with '&'.
https://www.ebi.ac.uk/gene2phenotype/terminology
Default levels are confirmed and probable.
all_confidence_levels : Set value to 1 to include all confidence levels: confirmed, probable and possible.
af_from_vcf : set value to 1 to include allele frequencies from VCF file.
Specifiy the list of reference populations to include with --af_from_vcf_keys
af_from_vcf_keys : VCF collections used for annotating variant alleles with observed
allele frequencies. Allele frequencies are retrieved from VCF files. If
af_from_vcf is set to 1 but no VCF collections are specified with --af_from_vcf_keys
all available VCF collections are included.
Available VCF collections: topmed, uk10k, gnomADe, gnomADg
Separate multiple values with '&'
VCF collections contain the following populations:
topmed: TOPMed
uk10k: ALSPAC, TWINSUK
gnomADe: gnomADe:AFR, gnomADe:ALL, gnomADe:AMR, gnomADe:ASJ, gnomADe:EAS, gnomADe:FIN, gnomADe:NFE, gnomADe:OTH, gnomADe:SAS
gnomADg: gnomADg:AFR, gnomADg:ALL, gnomADg:AMR, gnomADg:ASJ, gnomADg:EAS, gnomADg:FIN, gnomADg:NFE, gnomADg:OTH
default_af : default frequency of the input variant if no frequency data is
found (0). This determines whether such variants are included;
the value of 0 forces variants with no frequency data to be
included as this is considered equivalent to having a frequency
of 0. Set to 1 (or any value higher than af) to exclude them.
types : SO consequence types to include. Separate multiple values with '&'
(splice_donor_variant,splice_acceptor_variant,stop_gained,
frameshift_variant,stop_lost,initiator_codon_variant,
inframe_insertion,inframe_deletion,missense_variant,
coding_sequence_variant,start_lost,transcript_ablation,
transcript_amplification,protein_altering_variant)
log_dir : write stats to log files in log_dir
txt_report : write all G2P complete genes and attributes to txt file
html_report : write all G2P complete genes and attributes to html file
Example:
--plugin G2P,file=G2P.csv,af_monoallelic=0.05,types=stop_gained&frameshift_variant
--plugin G2P,file=G2P.csv,af_monoallelic=0.05,af_from_vcf=1
--plugin G2P,file=G2P.csv,af_from_vcf=1,af_from_vcf_keys=topmed&gnomADg
--plugin G2P,file=G2P.csv,af_from_vcf=1,af_from_vcf_keys=topmed&gnomADg,confidence_levels='confirmed&probable&both RD and IF'
--plugin G2P,file=G2P.csv
=cut
package G2P;
use strict;
use warnings;
use Cwd;
use Scalar::Util qw(looks_like_number);
use FileHandle;
use Text::CSV;
use Bio::EnsEMBL::Utils::Sequence qw(reverse_comp);
use Bio::EnsEMBL::Variation::DBSQL::VCFCollectionAdaptor;
use Bio::EnsEMBL::Variation::Utils::BaseVepPlugin;
use base qw(Bio::EnsEMBL::Variation::Utils::BaseVepPlugin);
our $CAN_USE_HTS_PM;
BEGIN {
if (eval { require Bio::DB::HTS::Tabix; 1 }) {
$CAN_USE_HTS_PM = 1;
}
}
my %DEFAULTS = (
# vars must have a frequency <= to this to pass
af_monoallelic => 0.0001,
af_biallelic => 0.005,
af_keys => [qw(AA AFR AMR EA EAS EUR SAS gnomAD gnomAD_AFR gnomAD_AMR gnomAD_ASJ gnomAD_EAS gnomAD_FIN gnomAD_NFE gnomAD_OTH gnomAD_SAS)],
af_from_vcf_keys => [qw(uk10k topmed gnomADe gnomADg)],
# if no MAF data is found, default to 0
# this means absence of MAF data is considered equivalent to MAF=0
# set to 1 to do the "opposite", i.e. exclude variants with no MAF data
default_af => 0,
confidence_levels => [qw(confirmed probable)],
# only include variants with these consequence types
# currently not ontology-resolved, exact term matches only
types => {map {$_ => 1} qw(splice_donor_variant splice_acceptor_variant stop_gained frameshift_variant stop_lost initiator_codon_variant inframe_insertion inframe_deletion missense_variant coding_sequence_variant start_lost transcript_ablation transcript_amplification protein_altering_variant)},
);
my $af_key_2_population_name = {
minor_allele_freq => 'global allele frequency (AF) from 1000 Genomes Phase 3 data',
AFR => '1000GENOMES:phase_3:AFR',
AMR => '1000GENOMES:phase_3:AMR',
EAS => '1000GENOMES:phase_3:EAS',
EUR => '1000GENOMES:phase_3:EUR',
SAS => '1000GENOMES:phase_3:SAS',
AA => 'Exome Sequencing Project 6500:African_American',
EA => 'Exome Sequencing Project 6500:European_American',
gnomAD => 'Genome Aggregation Database:Total',
gnomAD_AFR => 'Genome Aggregation Database exomes v2.1:African/African American',
gnomAD_AMR => 'Genome Aggregation Database exomes v2.1:Latino/Admixed American',
gnomAD_ASJ => 'Genome Aggregation Database exomes v2.1:Ashkenazi Jewish',
gnomAD_EAS => 'Genome Aggregation Database exomes v2.1:East Asian',
gnomAD_FIN => 'Genome Aggregation Database exomes v2.1:Finnish',
gnomAD_NFE => 'Genome Aggregation Database exomes v2.1:Non-Finnish European',
gnomAD_OTH => 'Genome Aggregation Database exomes v2.1:Other (population not assigned)',
gnomAD_SAS => 'Genome Aggregation Database exomes v2.1:South Asian',
};
my $allelic_requirements = {
'biallelic' => { af => 0.005, rules => {HET => 2, HOM => 1} },
'monoallelic' => { af => 0.0001, rules => {HET => 1, HOM => 1} },
'hemizygous' => { af => 0.0001, rules => {HET => 1, HOM => 1} },
'x-linked dominant' => { af => 0.0001, rules => {HET => 1, HOM => 1} },
'x-linked over-dominance' => { af => 0.0001, rules => {HET => 1, HOM => 1} },
};
my $supported_confidence_levels = {
'confirmed' => 1,
'probable' => 1,
'possible' => 1,
'both RD and IF' => 1,
};
my @allelic_requirement_terms = keys %$allelic_requirements;
sub new {
my $class = shift;
my $self = $class->SUPER::new(@_);
# suppress warnings that the FeatureAdpators spit if using no_slice_cache
Bio::EnsEMBL::Utils::Exception::verbose(1999);
my $params = $self->params_to_hash();
my $file = '';
# user only supplied file as first param?
if (!keys %$params) {
$file = $self->params->[0];
$params->{file} = $file;
}
else {
$file = $params->{file};
# process types
if ($params->{types}) {
$params->{types} = {map {$_ => 1} split(/[\;\&\|]/, $params->{types})};
}
# check af
foreach my $af (qw/af_monoallelic af_biallelic/) {
if($params->{$af}) {
die("ERROR: Invalid value for af: ".$params->{$af} . "\n") unless
looks_like_number($params->{$af}) && ($params->{$af} >= 0 && $params->{$af} <= 1)
}
my $ar = $af;
$ar =~ s/af_//;
$allelic_requirements->{$ar}->{af} = $params->{$af} if (defined $params->{$af});
}
$params->{af_keys} = \@{$DEFAULTS{af_keys}};
}
my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = localtime(time);
$year += 1900;
$mon++;
my $stamp = join('_', ($year, $mon, $mday, $hour, $min, $sec));
my $cwd_dir = getcwd;
my $new_log_dir = "$cwd_dir/g2p_log_dir\_$stamp";
my $log_dir = $params->{log_dir} || $new_log_dir;
if (!-d $log_dir) {
my $return = mkdir $log_dir, 0755;
die("ERROR: Couldn't create log_dir $log_dir $!\n") if (!$return);
$params->{log_dir} = $log_dir;
}
foreach my $report_type (qw/txt_report html_report/) {
if (!$params->{$report_type}) {
my $file_type = ($report_type eq 'txt_report') ? 'txt' : 'html';
$params->{$report_type} = $cwd_dir . "/$report_type\_$stamp.$file_type";
}
}
if ($params->{all_confidence_levels}) {
push @{$params->{confidence_levels}}, 'possible', @{$DEFAULTS{confidence_levels}};
}
if ($params->{confidence_levels}) {
my @confidence_levels = ();
foreach my $confidence_level (split(/[\;\&\|]/, $params->{confidence_levels})) {
if (!$supported_confidence_levels->{$confidence_level}) {
die "$confidence_level is not a supported value for supported confidence levels. Supported values are: ", join(', ', keys %$supported_confidence_levels);
} else {
push @confidence_levels, $confidence_level;
push @confidence_levels, 'both DD and IF' if ($confidence_level eq 'both RD and IF'); # legacy support for using both DD and IF
}
}
if (scalar @confidence_levels > 0) {
$params->{confidence_levels} = \@confidence_levels;
}
}
if ($params->{af_from_vcf}) {
if ($CAN_USE_HTS_PM) {
my @vcf_collection_ids = ();
my $assembly = $self->{config}->{assembly};
if ($params->{af_from_vcf_keys}) {
foreach my $key (split(/[\;\&\|]/, $params->{af_from_vcf_keys})) {
push @vcf_collection_ids, $key;
push @vcf_collection_ids, "$key\_$assembly";
}
} else {
foreach my $key (@{$DEFAULTS{af_from_vcf_keys}}) {
push @vcf_collection_ids, "$key\_$assembly";
}
}
my $species = $self->{config}->{species};
my $reg = $self->{config}->{reg};
my $vca;
if (defined $self->{config}->{offline}) {
$vca = Bio::EnsEMBL::Variation::DBSQL::VCFCollectionAdaptor->new();
} else {
my $vdba = $reg->get_DBAdaptor($species, 'variation');
$vdba->dbc->reconnect_when_lost(1);
$vca = $vdba->get_VCFCollectionAdaptor;
$vca->db->use_vcf(2);
}
my $vcf_collections = $vca->fetch_all;
my @collections = ();
foreach my $vcf_collection (@$vcf_collections) {
$vcf_collection->use_db(0) if (defined $self->{config}->{offline});
my $vcf_collection_id = $vcf_collection->id;
if ($vcf_collection->assembly eq $assembly && grep {$_ =~ /$vcf_collection_id/i} @vcf_collection_ids) {
delete $vcf_collection->adaptor->{collections};
delete $vcf_collection->adaptor->{config};
my $description = $vcf_collection->description || $vcf_collection_id;
foreach my $population (@{$vcf_collection->get_all_Populations}) {
my $population_name = $population->name;
my $population_description = $population->description;
$af_key_2_population_name->{$population_name} = "$description $population_name $population_description";
}
push @collections, $vcf_collection;
}
}
warn "Couln't find VCF collection ids for assembly " . $assembly if (!@collections);
$self->{config}->{vcf_collections} = \@collections;
$self->{config}->{use_vcf} = 1;
} else {
warn "Cannot get data from VCF without Bio::DB::HTS::Tabix";
}
}
# copy in default params
$params->{$_} //= $DEFAULTS{$_} for keys %DEFAULTS;
$self->{user_params} = $params;
$self->{config}->{frequency_threshold} = _get_highest_frequency_threshold();
# read data from file
$self->{gene_data} = $self->read_gene_data_from_file($file);
$self->synonym_mappings();
# force some config params
$self->{config}->{individual} //= ['all'];
$self->{config}->{symbol} = 1;
$self->{config}->{check_existing} = 1;
$self->{config}->{failed} = 1;
$self->{config}->{af} = 1;
$self->{config}->{af_1kg} = 1;
$self->{config}->{af_esp} = 1;
$self->{config}->{af_gnomad} = 1;
$self->{config}->{sift} = 'b';
$self->{config}->{polyphen} = 'b';
# tell VEP we have a cache so stuff gets shared/merged between forks
$self->{has_cache} = 1;
$self->{cache}->{g2p_in_vcf} = {};
return $self;
}
sub _get_highest_frequency_threshold {
my $highest_frequency = 0.0;
foreach my $ar (keys %$allelic_requirements) {
if ($allelic_requirements->{$ar}->{af} > $highest_frequency) {
$highest_frequency = $allelic_requirements->{$ar}->{af};
}
}
return $highest_frequency;
}
sub feature_types {
return ['Transcript'];
}
sub get_header_info {
my $self = shift;
return {
G2P_flag => 'Flags zygosity of valid variants for a G2P gene',
G2P_complete => 'Indicates this variant completes the allelic requirements for a G2P gene',
G2P_gene_req => 'MONO or BI depending on the context in which this gene has been explored',
};
}
sub run {
my ($self, $tva, $line) = @_;
# only interested if we know the zygosity
my $zyg = defined($line->{Extra}) ? $line->{Extra}->{ZYG} : $line->{ZYG};
return {} unless $zyg;
return {} if (!$self->gene_overlap_filtering($tva));
return {} unless grep {$self->{user_params}->{types}->{$_->SO_term}} @{$tva->get_all_OverlapConsequences};
return {} if (!$self->frequency_filtering($tva));
$self->dump_vf_annotations($tva);
$self->dump_individual_annotations($tva, $zyg);
my $G2P_complete = $self->is_g2p_complete($tva, $zyg);
my $G2P_flag = $self->is_valid_g2p_variant($tva, $zyg);
my $results = {};
$results->{G2P_complete} = $G2P_complete if ($G2P_complete);
$results->{G2P_flag} = $G2P_flag if ($G2P_flag);
return $results;
}
sub is_valid_g2p_variant {
my $self = shift;
my $tva = shift;
my $zyg = shift;
my $transcript = $tva->transcript;
my $gene_stable_id = $transcript->{_gene}->stable_id;
my @allelic_requirements = keys %{$self->{ar}->{$gene_stable_id}};
my @results = ();
foreach my $ar (@allelic_requirements) {
my $ar_rules = $allelic_requirements->{$ar};
my $af_threshold = $ar_rules->{af};
if ($self->exceeds_threshold($af_threshold, [$self->{vf_cache_name}])) {
push @results, "$ar=$zyg";
}
}
return join(',', @results);
}
sub is_g2p_complete {
my $self = shift;
my $tva = shift;
my $zyg = shift;
my $vf = $tva->base_variation_feature;
my $individual = $vf->{individual};
my $transcript = $tva->transcript;
my $gene_stable_id = $transcript->{_gene}->stable_id;
my $transcript_stable_id = $transcript->stable_id;
$self->{per_individual}->{$individual}->{$transcript_stable_id}->{$zyg}->{$self->{vf_cache_name}} = 1;
my @allelic_requirements = keys %{$self->{ar}->{$gene_stable_id}};
my $G2P_complete;
foreach my $ar (@allelic_requirements) {
my $zyg2var = $self->{per_individual}->{$individual}->{$transcript_stable_id};
my $fulfils_ar = $self->obeys_rule($ar, $zyg2var);
if (scalar keys %$fulfils_ar > 0) {
$G2P_complete .= "$ar=";
my @passed_variants = ();
foreach my $zyg (keys %$fulfils_ar) {
my @tmp = ();
foreach my $var (@{$fulfils_ar->{$zyg}}) {
push @tmp, "$zyg:$var";
}
push @passed_variants, join('&', @tmp);
}
$G2P_complete = "$ar=" . join(',', @passed_variants);
}
}
return $G2P_complete;
}
sub obeys_rule {
my $self = shift;
my $ar = shift;
my $zyg2variants = shift;
my $ar_rules = $allelic_requirements->{$ar};
my $af_threshold = $ar_rules->{af};
my $zyg2counts = $ar_rules->{rules};
my $results = {};
foreach my $zyg (keys %$zyg2counts) {
my $count = $zyg2counts->{$zyg};
my @all_variants = keys %{$zyg2variants->{$zyg}};
my $variants = $self->exceeds_threshold($af_threshold, \@all_variants);
if (scalar @$variants >= $count) {
$results->{$zyg} = $variants;
}
}
return $results;
}
sub exceeds_threshold {
my $self = shift;
my $af_threshold = shift;
my $variants = shift;
my @pass_variants = ();
foreach my $variant (@$variants) {
if (!defined $self->{highest_frequencies}->{$variant} || $self->{highest_frequencies}->{$variant} <= $af_threshold) {
push @pass_variants, $variant;
}
}
return \@pass_variants;
}
sub gene_overlap_filtering {
my $self = shift;
my $tva = shift;
my $transcript = $tva->transcript;
my $gene = $transcript->{_gene};
my $gene_stable_id = $gene->stable_id;
my $pass_gene_overlap_filter = $self->{g2p_gene_cache}->{$gene_stable_id};
my @gene_xrefs = ();
if (! defined $pass_gene_overlap_filter) {
my $gene_symbol = $transcript->{_gene_symbol} || $transcript->{_gene_hgnc};
$pass_gene_overlap_filter = 0;
foreach my $gene_id ($gene_symbol, $gene_stable_id) {
my $gene_data = $self->gene_data($gene_id) if (defined $gene_id);
if (defined $gene_data) {
if (defined $gene_data->{'allelic requirement'} && scalar @{$gene_data->{'allelic requirement'}}) {
foreach my $ar (@{$gene_data->{'allelic requirement'}}) {
$self->{ar}->{$gene_stable_id}->{$ar} = 1;
}
$self->write_report('G2P_gene_data', $gene_stable_id, $gene_data, $gene_data->{'gene_xrefs'});
}
$self->write_report('G2P_in_vcf', $gene_stable_id);
$pass_gene_overlap_filter = 1;
last;
}
}
$self->{g2p_gene_cache}->{$gene_stable_id} = $pass_gene_overlap_filter;
}
$self->_dump_transcript_annotations($transcript) if ($pass_gene_overlap_filter);
return $self->{g2p_gene_cache}->{$gene_stable_id};
}
sub _dump_transcript_annotations {
my $self = shift;
my $transcript = shift;
my $transcript_stable_id = $transcript->stable_id;
if (!defined $self->{g2p_transcript_cache}->{$transcript_stable_id}) {
my $gene = $transcript->{_gene};
my $gene_stable_id = $gene->stable_id;
if ($transcript->is_canonical) {
$self->write_report('G2P_transcript_data', "$gene_stable_id\t$transcript_stable_id\tis_canonical");
}
$self->{g2p_transcript_cache}->{$transcript_stable_id} = 1;
}
}
sub get_cache_name {
my $self = shift;
my $vf = shift;
my $cache_name = ($vf->{original_chr} || $vf->{chr}) . '_' . $vf->{start} . '_' . ($vf->{allele_string} || $vf->{class_SO_term});
return $cache_name;
}
sub frequency_filtering {
my $self = shift;
my $tva = shift;
my $vf = $tva->base_variation_feature;
my $vf_cache_name = $self->get_cache_name($vf);
$self->{vf_cache_name} = $vf_cache_name;
$self->{g2p_vf_cache} = {} if (!defined $self->{g2p_vf_cache}->{$vf_cache_name});
my $pass_frequency_filter = $self->{g2p_vf_cache}->{$vf_cache_name}->{pass_frequency_filter};
return $pass_frequency_filter if (defined $pass_frequency_filter);
$pass_frequency_filter = $self->_vep_cache_frequency_filtering($tva);
if ($pass_frequency_filter && $self->{config}->{use_vcf}) {
$pass_frequency_filter = $self->_vcf_frequency_filtering($tva);
}
$self->{g2p_vf_cache}->{$vf_cache_name}->{pass_frequency_filter} = $pass_frequency_filter;
return $self->{g2p_vf_cache}->{$vf_cache_name}->{pass_frequency_filter};
}
sub _vep_cache_frequency_filtering {
my $self = shift;
my $tva = shift;
my $allele = $tva->variation_feature_seq;
my $vf = $tva->base_variation_feature;
my $frequency_threshold = $self->{config}->{frequency_threshold};
my $existing = $vf->{existing};
my @keys = @{$self->{user_params}->{af_keys}};
my $dumped_annotations = 0;
foreach my $existing_var (@$existing) {
my @frequencies = grep defined, @{$existing_var}{@keys};
next if (!@frequencies);
if ($self->_exceeds_frequency_threshold(\@frequencies, $allele, $frequency_threshold)) {
return 0;
} else {
$self->_dump_existing_vf_frequencies($existing_var, $allele);
$self->_dump_existing_vf_annotations($existing_var);
$dumped_annotations = 1;
}
}
$self->_dump_existing_vf_annotations() if (!$dumped_annotations);
return 1;
}
sub _dump_existing_vf_frequencies {
my $self = shift;
my $existing_var = shift;
my $allele = shift;
my @keys = @{$self->{user_params}->{af_keys}};
my @frequencies = ();
my $higest_frequency = 0;
foreach my $population_name (@keys) {
my $af = $existing_var->{$population_name};
next if (!defined $af);
foreach my $pair (split(',', $af)) {
my ($a, $f) = split(':', $pair);
if(($a || '') eq $allele && defined($f)) {
push @frequencies, "$population_name=$f";
$higest_frequency = $f if ($f > $higest_frequency);
}
}
}
$self->store_highest_frequency($higest_frequency);
$self->write_report('G2P_frequencies', $self->{vf_cache_name}, \@frequencies);
}
sub _dump_existing_vf_annotations {
my $self = shift;
my $existing_var = shift;
my $data = {
'clin_sig' => 'NA',
'failed' => 'NA',
'existing_name' => 'NA',
'novel' => 'yes',
};
if ($existing_var) {
$data = {
'clin_sig' => $existing_var->{clin_sig} || 'NA',
'failed' => ($existing_var->{failed}) ? 'yes' : 'no',
'existing_name' => $existing_var->{variation_name} || 'NA',
'novel' => 'no',
};
}
$self->write_report('G2P_existing_vf_annotations', $self->{vf_cache_name}, $data);
}
sub _exceeds_frequency_threshold {
my $self = shift;
my $vep_cache_frequencies = shift;
my $allele = shift;
my $threshold = shift;
foreach my $vep_cache_frequency (@$vep_cache_frequencies) {
foreach my $pair (split(',', $vep_cache_frequency)) {
my ($a, $f) = split(':', $pair);
if(($a || '') eq $allele && defined($f)) {
return 1 if ($f > $threshold);
}
}
}
return 0;
}
sub _vcf_frequency_filtering {
my $self = shift;
my $tva = shift;
my $allele = $tva->variation_feature_seq;
my $vf = $tva->base_variation_feature;
my $frequency_threshold = $self->{config}->{frequency_threshold};
foreach my $vcf_collection (@{$self->{config}->{vcf_collections}}) {
my @alleles = grep {$_->allele eq $allele} @{$vcf_collection->get_all_Alleles_by_VariationFeature($vf)};
my @frequencies = grep {$_->frequency > $frequency_threshold} @alleles;
if (scalar @frequencies > 0) {
return 0;
} else {
$self->_dump_existing_vf_vcf(\@alleles) if (scalar @alleles);
}
}
return 1;
}
sub _dump_existing_vf_vcf {
my $self = shift;
my $alleles = shift;
my @frequencies = map {$_->population->name . '=' . $_->frequency} @$alleles;
my @sorted_frequencies = sort { $a->frequency <=> $b->frequency } @$alleles;
$self->store_highest_frequency($sorted_frequencies[-1]->frequency);
$self->write_report('G2P_frequencies', $self->{vf_cache_name}, \@frequencies);
}
sub store_highest_frequency {
my $self = shift;
my $f = shift;
$self->{highest_frequency}->{$self->{vf_cache_name}} = $f;
}
sub dump_vf_annotations {
my $self = shift;
my $tva = shift;
my @consequence_types = map { $_->SO_term } @{$tva->get_all_OverlapConsequences};
my $vf = $tva->base_variation_feature;
my $allele = $tva->variation_feature_seq;
my $start = $vf->{start};
my $end = $vf->{end};
my $individual = $vf->{individual};
my $vf_name = $vf->variation_name;
my $vf_cache_name = $self->{vf_cache_name};
my $allele_string = $vf->{allele_string};
my @alleles = split('/', $allele_string);
my $ref = $alleles[0];
my $seq_region_name = $vf->{chr};
my $params = $self->{user_params};
my $tr = $tva->transcript;
my $refseq = $tr->{_refseq} || 'NA';
my $hgvs_t = $tva->hgvs_transcript || 'NA';
my $hgvs_p = $tva->hgvs_protein || 'NA';
my $pph_score = (defined $tva->polyphen_score) ? $tva->polyphen_score : 'NA';
my $pph_pred = (defined $tva->polyphen_prediction) ? $tva->polyphen_prediction : 'NA';
my $sift_score = (defined $tva->sift_score) ? $tva->sift_score : 'NA';
my $sift_pred = (defined $tva->sift_prediction) ? $tva->sift_prediction : 'NA';
my $g2p_data = {
'vf_name' => $vf_name,
'transcript_stable_id' => $tr->stable_id,
'consequence_types' => join(',', @consequence_types),
'refseq' => $refseq,
'hgvs_t' => $hgvs_t,
'hgvs_p' => $hgvs_p,
'vf_location' => "$seq_region_name:$start-$end $ref/$allele",
'sift_score' => "$sift_score",
'sift_prediction' => $sift_pred,
'polyphen_score' => "$pph_score",
'polyphen_prediction' => $pph_pred,
};
$self->write_report('G2P_tva_annotations', $vf_cache_name, $tr->stable_id, $g2p_data);
}
sub dump_individual_annotations {
my $self = shift;
my $tva = shift;
my $zyg = shift;
my $vf = $tva->base_variation_feature;
my $individual = $vf->{individual};
my $vf_cache_name = $self->{vf_cache_name};
my $transcript = $tva->transcript;
my $transcript_stable_id = $transcript->stable_id;
my $gene_stable_id = $transcript->{_gene_stable_id};
$self->write_report('G2P_individual_annotations', join("\t", $gene_stable_id, $transcript_stable_id, $vf_cache_name, $zyg, $individual));
}
# read G2P CSV dump
# as from http://www.ebi.ac.uk/gene2phenotype/downloads
sub read_gene_data_from_file {
my $self = shift;
my $file = shift;
my $delimiter = shift;
my (@headers, %gene_data);
my $assembly = $self->{config}->{assembly};
die("ERROR: No file specified or could not read from file ".($file || '')."\n") unless $file && -e $file;
my @confidence_levels = @{$self->{user_params}->{confidence_levels}};
# determine file type
my $file_type;
my $fh = FileHandle->new($file, 'r');
while (<$fh>) {
chomp;
if (/Model_Of_Inheritance/) {
$file_type = 'panelapp';
} elsif (/allelic requirement/) {
$file_type = 'g2p';
} else {
$file_type = 'unknown';
}
last;
}
$fh->close();
if ($file_type eq 'unknown') {
if ($file =~ /gz$/) {
die("ERROR: G2P plugin can only read uncompressed data\n");
} else {
die("ERROR: Could not recognize input file format. Format must be one of panelapp, g2p or custom. Check website for details: https://www.ebi.ac.uk/gene2phenotype/g2p_vep_plugin\n");
}
}
if ($file_type eq 'panelapp') {
my @headers = ();
my $csv = Text::CSV->new ({ sep_char => "\t" });
open my $fh, "<:encoding(utf8)", "$file" or die "$file: $!";
while ( my $row = $csv->getline( $fh ) ) {
unless (@headers) {
@headers = @$row;
} else {
my %tmp = map {$headers[$_] => $row->[$_]} (0..$#headers);
my $gene_symbol = $tmp{"Gene Entity Symbol"};
my $ensembl_gene_id = "";
if ($assembly eq 'GRCh37') {
$ensembl_gene_id = $tmp{"EnsemblId(GRch37)"};
} else { # GRCh38
$ensembl_gene_id = $tmp{"EnsemblId(GRch38)"};
}
if ($ensembl_gene_id) {
my @ars = ();
my $allelic_requirement_panel_app = $tmp{"Model_Of_Inheritance"};
if ($allelic_requirement_panel_app =~ m/MONOALLELIC|BOTH/) {
push @ars, 'monoallelic';
} elsif ($allelic_requirement_panel_app =~ m/BIALLELIC|BOTH/) {
push @ars, 'biallelic';
} elsif ($allelic_requirement_panel_app eq 'X-LINKED: hemizygous mutation in males, biallelic mutations in females') {
push @ars, 'hemizygous';
} elsif ($allelic_requirement_panel_app eq 'X-LINKED: hemizygous mutation in males, monoallelic mutations in females may cause disease (may be less severe, later onset than males)') {
push @ars, 'x-linked dominant';
} else {
$self->write_report('log', "no allelelic_requirement for $ensembl_gene_id");
}
foreach my $ar (@ars) {
push @{$gene_data{$ensembl_gene_id}->{"allelic requirement"}}, $ar;
}
} else {
$self->write_report('log', "no ensembl gene id");
}
}
}
$csv->eof or $csv->error_diag();
close $fh;
}
if ($file_type eq 'g2p') {
# this regexp allows for nested ",", e.g.
# item,description
# cheese,"salty,delicious"
my $re = qr/(?: "\( ( [^()""]* ) \)" | \( ( [^()]* ) \) | " ( [^"]* ) " | ( [^,]* ) ) , \s* /x;
my $fh = FileHandle->new($file, 'r');
while(<$fh>) {
chomp;
$_ =~ s/\R//g;
my @split = grep defined, "$_," =~ /$re/g;
unless(@headers) {
if ($file_type eq 'g2p') {
@headers = map {s/\"//g; $_} @split;
} else {
@headers = @split;
}
}
else {
my %tmp = map {$headers[$_] => $split[$_]} (0..$#split);
die("ERROR: Gene symbol column not found\n$_\n") unless $tmp{"gene symbol"};
$self->write_report('G2P_list', $tmp{"gene symbol"}, $tmp{"DDD category"});
my $confidence_value = $tmp{"DDD category"} || $tmp{"confidence category"}; # deprecate use of DDD category
next if (!grep{$_ eq $confidence_value} @confidence_levels);
my $gene_symbol = $tmp{"gene symbol"};
push @{$gene_data{$gene_symbol}->{"gene_xrefs"}}, split(';', $tmp{"prev symbols"});
push @{$gene_data{$gene_symbol}->{"gene_xrefs"}}, $tmp{"gene symbol"};
push @{$gene_data{$gene_symbol}->{"allelic requirement"}}, $tmp{"allelic requirement"} if ($tmp{"allelic requirement"});
}
}
$fh->close;
}
return \%gene_data;
}
# return either whole gene data hash or one gene's data
# this should allow updates to this plugin to e.g. query a REST server, for example
sub gene_data {
my ($self, $gene_symbol) = @_;
my $gene_data = $self->{gene_data}->{$gene_symbol};
if (!$gene_data) {
my $prev_gene_symbol = $self->{prev_symbol_mappings}->{$gene_symbol};
return $prev_gene_symbol ? $self->{gene_data}->{$prev_gene_symbol} : undef;
}
return $gene_data;
}
sub synonym_mappings {
my $self = shift;
my $gene_data = $self->{gene_data};
my $synonym_mappings = {};
foreach my $gene_symbol (keys %$gene_data) {
foreach my $prev_symbol (@{$gene_data->{$gene_symbol}->{'gene_xrefs'}}) {
$synonym_mappings->{$prev_symbol} = $gene_symbol;
}
}
$self->{prev_symbol_mappings} = $synonym_mappings;
}
sub write_report {
my $self = shift;
my $flag = shift;
my $log_dir = $self->{user_params}->{log_dir};
my $log_file = "$log_dir/$$.txt";
open(my $fh, '>>', $log_file) or die "Could not open file '$flag $log_file' $!\n";
if ($flag eq 'G2P_list') {
my ($gene_symbol, $DDD_category) = @_;
$DDD_category ||= 'Not assigned';
print $fh "$flag\t$gene_symbol\t$DDD_category\n";
} elsif ($flag eq 'G2P_in_vcf') {
my $gene_symbol = shift;
print $fh "$flag\t$gene_symbol\n";
} elsif ($flag eq 'G2P_complete') {
print $fh join("\t", $flag, @_), "\n";
} elsif ($flag eq 'log') {
print $fh join("\t", $flag, @_), "\n";
} elsif ($flag eq 'G2P_gene_data') {
my ($gene_id, $gene_data, $gene_xrefs) = @_;
my $ar = join(',', @{$gene_data->{'allelic requirement'}});
my %seen;
$seen{$_} = 1 foreach @{$gene_xrefs};
my @unique = keys %seen;
my $xrefs = join(',', grep {$_ !~ /^ENS/} sort @unique);
print $fh join("\t", $flag, $gene_id, $ar, $xrefs), "\n";
} elsif ($flag eq 'G2P_frequencies') {
my ($vf_name, $frequencies) = @_;
print $fh join("\t", $flag, $vf_name, join(',', @$frequencies)), "\n";
} elsif ($flag eq 'G2P_tva_annotations') {
my ($vf_name, $transcript_stable_id, $data) = @_;
$data = join(';', map {"$_=$data->{$_}"} sort keys %$data);
print $fh join("\t", $flag, $vf_name, $transcript_stable_id, $data), "\n";
} elsif ($flag eq 'G2P_existing_vf_annotations') {
my ($vf_name, $data) = @_;
$data = join(';', map {"$_=$data->{$_}"} sort keys %$data);
print $fh join("\t", $flag, $vf_name, $data), "\n";
} elsif ($flag eq 'G2P_transcript_data') {
print $fh join("\t", $flag, @_), "\n";
} elsif ($flag eq 'G2P_individual_annotations') {
print $fh join("\t", $flag, @_), "\n";
} else {
print $fh "Did not recognize flag, @_\n";
}
close $fh;
}
sub finish {
my $self = shift;
$self->generate_report;
}
sub generate_report {
my $self = shift;
my $result_summary = $self->parse_log_files;
my $chart_txt_data = $self->chart_and_txt_data($result_summary);
my $chart_data = $chart_txt_data->{chart_data};
my $txt_data = $chart_txt_data->{txt_data};
$self->write_txt_output($txt_data, $result_summary->{gene_xrefs});
$self->write_charts($result_summary, $chart_data, $result_summary->{canonical_transcripts}, $result_summary->{gene_xrefs});
}
sub write_txt_output {
my $self = shift;
my $txt_output_data = shift;
my $gene_xrefs = shift;
my $txt_output_file = $self->{user_params}->{txt_report};
my $fh_txt = FileHandle->new($txt_output_file, 'w');
foreach my $individual (sort keys %$txt_output_data) {
foreach my $gene_id (keys %{$txt_output_data->{$individual}}) {
my $gene_id_title = (defined $gene_xrefs->{$gene_id}) ? "$gene_id(" . $gene_xrefs->{$gene_id} . ")" : $gene_id;
foreach my $ar (keys %{$txt_output_data->{$individual}->{$gene_id}}) {
foreach my $tr_stable_id (keys %{$txt_output_data->{$individual}->{$gene_id}->{$ar}}) {
my $is_canonical = $txt_output_data->{$individual}->{$gene_id}->{$ar}->{$tr_stable_id}->{is_canonical};
my $canonical_tag = ($is_canonical) ? 'is_canonical' : 'not_canonical';
my $req = $txt_output_data->{$individual}->{$gene_id}->{$ar}->{$tr_stable_id}->{REQ};
my $variants = join(';', @{$txt_output_data->{$individual}->{$gene_id}->{$ar}->{$tr_stable_id}->{variants}});
print $fh_txt join("\t", $individual, $gene_id_title, $tr_stable_id, $canonical_tag, "OBS=$ar", "REQ=$req", $variants), "\n";
}
}
}
}
$fh_txt->close();
}
sub write_charts {
my $self = shift;
my $result_summary = shift;
my $chart_data = shift;
my $canonical_transcripts = shift;
my $gene_xrefs = shift;
my $count_g2p_genes = keys %{$result_summary->{g2p_list}};
my $count_in_vcf_file = keys %{$result_summary->{in_vcf_file}};
my $count_complete_genes = scalar keys %{$result_summary->{complete_genes}};
my @charts = ();
my @frequencies_header = ();
foreach my $short_name (sort keys %{$self->{population_names}}) {
my $text = $af_key_2_population_name->{$short_name} || 'No description';
push @frequencies_header, "<a style=\"cursor: pointer\" data-placement=\"top\" data-toggle=\"tooltip\" data-container=\"body\" title=\"$text\">$short_name</a>";
}
my $count = 1;
my @new_header = (
'Variant location and alleles (REF/ALT)',
'Variant name',
'Existing name',
'Zygosity',
'All allelic requirements from G2P DB',
'Consequence types',
'ClinVar annotation',
'SIFT',
'PolyPhen',
'Novel variant',
'Has been failed by Ensembl',
@frequencies_header,
'HGVS transcript',
'HGVS protein',
'RefSeq IDs',
);
my $html_output_file = $self->{user_params}->{html_report};
my $fh_out = FileHandle->new($html_output_file, 'w');
print $fh_out stats_html_head(\@charts);
print $fh_out "<div class='main_content container'>";
print $fh_out "<h1>G2P report</h1>";
print $fh_out "<p>Input and output files:</p>";
print $fh_out "<dl class='dl-horizontal'>";
print $fh_out "<dt>G2P list</dt>";
print $fh_out "<dd>" . $self->{user_params}->{file} . "</dd>";
print $fh_out "<dt>Log directory</dt>";
print $fh_out "<dd>" . $self->{user_params}->{log_dir} . "</dd>";
print $fh_out "<dt>HTML report</dt>";
print $fh_out "<dd>" . $self->{user_params}->{html_report} . "</dd>";
print $fh_out "<dt>TXT report</dt>";
print $fh_out "<dd>" . $self->{user_params}->{txt_report} . "</dd>";
print $fh_out "</dl>";
print $fh_out "<p>Counts:</p>";
print $fh_out "<dl class='dl-horizontal text-overflow'>";
print $fh_out "<dt>$count_g2p_genes</dt>";
print $fh_out "<dd>G2P genes</dd>";
print $fh_out "<dt>$count_in_vcf_file</dt>";
print $fh_out "<dd>G2P genes in input VCF file</dd>";
print $fh_out "<dt>$count_complete_genes</dt>";
print $fh_out "<dd>G2P complete genes in input VCF file</dd>";
print $fh_out "</dl>";
print $fh_out "<h1>Summary of G2P complete genes per individual</h1>";
print $fh_out "<p>G2P complete gene: A sufficient number of variant hits for the observed allelic requirement in at least one of the gene's transcripts. Variants are filtered by frequency.</p>";