annotate dir_plugins/HGVSReferenceBase.pm @ 10:f594c6bed58f draft default tip

Uploaded
author dvanzessen
date Tue, 21 Apr 2020 11:40:19 +0000
parents e545d0a25ffe
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
1 =head1 LICENSE
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
2 Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
3 Copyright [2016-2018] EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
4 Licensed under the Apache License, Version 2.0 (the "License");
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
5 you may not use this file except in compliance with the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
6 You may obtain a copy of the License at
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
7 http://www.apache.org/licenses/LICENSE-2.0
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
8 Unless required by applicable law or agreed to in writing, software
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
9 distributed under the License is distributed on an "AS IS" BASIS,
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
10 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
11 See the License for the specific language governing permissions and
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
12 limitations under the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
13
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
14 =head1 CONTACT
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
15
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
16 Ensembl <http://www.ensembl.org/info/about/contact/index.html>
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
17
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
18 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
19
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
20 =head1 NAME
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
21
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
22 HGVSReferenceBase
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
23
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
24 =head1 SYNOPSIS
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
25
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
26 mv HGVSReferenceBase.pm ~/.vep/Plugins
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
27 ./vep -i variations.vcf --cache --hgvs --plugin HGVSReferenceBase
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
28
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
29 =head1 DESCRIPTION
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
30
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
31 This is a plugin for the Ensembl Variant Effect Predictor (VEP) that
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
32 reports the reference base for the variant, as used in the longer form.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
33 of HGVS. To be used with --hgvs option.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
34
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
35 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
36
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
37
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
38 package HGVSReferenceBase;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
39
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
40 use strict;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
41 use warnings;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
42
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
43 use Bio::EnsEMBL::Variation::Utils::BaseVepPlugin;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
44 use Bio::EnsEMBL::Variation::DBSQL::TranscriptVariationAdaptor;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
45 use Bio::EnsEMBL::Variation::DBSQL::DBAdaptor;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
46 use Bio::EnsEMBL::Variation::TranscriptVariationAllele;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
47
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
48 use base qw(Bio::EnsEMBL::Variation::Utils::BaseVepPlugin);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
49
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
50
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
51 sub feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
52 return ['Transcript'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
53 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
54
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
55 sub variant_feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
56 return ['VariationFeature'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
57 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
58
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
59 sub get_header_info {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
60 my $self = shift;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
61
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
62 return {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
63 'HGVS_ref' => 'Reference base as may be reported in HGVS transcript level notation',
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
64 };
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
65 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
66
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
67 sub run {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
68 my ($self, $tva) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
69
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
70 # check var class, this is only useful for deletions
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
71 # or duplications - a subset of insertions
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
72 return {} unless $tva->variation_feature->var_class() =~ /del|ins/;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
73
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
74 return $tva->hgvs_transcript_reference() ? {'HGVS_ref' => $tva->hgvs_transcript_reference()} : {};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
75
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
76 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
77
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
78 1;