annotate dir_plugins/GO.pm @ 0:e545d0a25ffe draft

Uploaded
author dvanzessen
date Mon, 15 Jul 2019 05:17:17 -0400
parents
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
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
3 Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
4 Copyright [2016-2018] EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
5
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
6 Licensed under the Apache License, Version 2.0 (the "License");
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
7 you may not use this file except in compliance with the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
8 You may obtain a copy of the License at
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
9
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
10 http://www.apache.org/licenses/LICENSE-2.0
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
11
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
12 Unless required by applicable law or agreed to in writing, software
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
13 distributed under the License is distributed on an "AS IS" BASIS,
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
15 See the License for the specific language governing permissions and
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
16 limitations under the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
17
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
18 =head1 CONTACT
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
19
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
20 Ensembl <http://www.ensembl.org/info/about/contact/index.html>
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
21
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
22 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
23
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
24 =head1 NAME
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
25
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
26 GO
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
27
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
28 =head1 SYNOPSIS
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
29
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
30 mv GO.pm ~/.vep/Plugins
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
31 ./vep -i variations.vcf --plugin GO
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
32
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
33 =head1 DESCRIPTION
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
34
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
35 A VEP plugin that retrieves Gene Ontology terms associated with
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
36 transcripts/translations via the Ensembl API. Requires database connection.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
37
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
38 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
39
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
40 package GO;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
41
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
42 use strict;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
43 use warnings;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
44
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
45 use Bio::EnsEMBL::Variation::Utils::BaseVepPlugin;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
46
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
47 use base qw(Bio::EnsEMBL::Variation::Utils::BaseVepPlugin);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
48
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
49 sub new {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
50 my $class = shift;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
51
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
52 my $self = $class->SUPER::new(@_);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
53
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
54 # connect to DB for offline users
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
55 my $config = $self->{config};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
56 my $reg = $config->{reg};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
57
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
58 if(!defined($self->{config}->{sa})) {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
59 $reg = 'Bio::EnsEMBL::Registry';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
60 $reg->load_registry_from_db(
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
61 -host => $config->{host},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
62 -user => $config->{user},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
63 -pass => $config->{password},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
64 -port => $config->{port},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
65 -db_version => $config->{db_version},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
66 -species => $config->{species} =~ /^[a-z]+\_[a-z]+/i ? $config->{species} : undef,
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
67 -verbose => $config->{verbose},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
68 -no_cache => $config->{no_slice_cache},
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
69 );
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
70 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
71
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
72 return $self;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
73 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
74
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
75 sub version {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
76 return 73;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
77 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
78
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
79 sub feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
80 return ['Transcript'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
81 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
82
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
83 sub get_header_info {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
84 return { 'GO' => 'GO terms associated with protein product'};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
85 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
86
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
87 sub run {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
88 my ($self, $tva) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
89
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
90 my $tr = $tva->transcript->translation;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
91 return {} unless defined($tr);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
92
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
93 my $entries = $tr->get_all_DBEntries('GO');
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
94
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
95 my $string = join(",", map {$_->display_id.':'.$_->description} @$entries);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
96 $string =~ s/\s+/\_/g;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
97
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
98 return { GO => $string };
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
99 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
100
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
101 1;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
102