annotate variant_effect_predictor/Bio/EnsEMBL/SNP.pm @ 0:2bc9b66ada89 draft default tip

Uploaded
author mahtabm
date Thu, 11 Apr 2013 06:29:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
2
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
5
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
8
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
10
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
12
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
15
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::SNP
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25 =head1 SYNOPSIS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27 $snp = new Bio::EnsEMBL::SNP(
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 -start => 10,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29 -end => 10,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 -strand => 1,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31 -source => 'The SNP Consortium',
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 -score => 99, # new meaning
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 -status => 'suspected', # new
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34 -alleles => 't|c' # new
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37 # add it to an annotated sequence
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39 $annseq->add_SeqFeature($feat);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43 This class was written because the EnsEMBL::ExternalData::Variation
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44 object is way too slow. There was simply too much chaining to bioperl
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45 methods many, many layers deep. This object behaves like a Variation
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46 but has a much faster constructor, and faster accessors for the relevant
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 methods needed by the web.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 =head1 METHODS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 package Bio::EnsEMBL::SNP;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55 use vars qw(@ISA);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59 use Bio::EnsEMBL::ExternalData::Variation;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 use Scalar::Util qw(weaken isweak);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 @ISA = qw( Bio::EnsEMBL::ExternalData::Variation );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65 sub new_fast {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 my $class = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67 my $hashref = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68 my $self = bless $hashref, $class;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 weaken($self->{adaptor}) if ( ! isweak($self->{adaptor}) );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70 return $self;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73 sub dbID {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76 if(@_) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 $self->{'dbID'} = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80 return $self->{'dbID'};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 sub position {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87 $self->{_gsf_start} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88 $self->{_gsf_end} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91 return $self->{_gsf_start};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 sub start {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98 $self->{_gsf_start} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 return $self->{_gsf_start};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 sub end {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 $self->{_gsf_end} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111 return $self->{_gsf_end};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 sub source {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119 $self->{_source} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122 return $self->{_source};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 sub score {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129 $self->{_gsf_score} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132 return $self->{_gsf_score};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 sub source_tag {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 $self->{_source_tag} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 return $self->{_source_tag};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 sub source_version {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 my ($self, $arg) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 if(defined $arg) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150 $self->{_source_version} = $arg;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153 return $self->{_source_version};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157 =head2 display_name
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159 Arg [1] : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 Example : print $snp->display_name();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161 Description: This method returns a string that is considered to be
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
162 the 'display' identifier. For snps this is the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
163 returns the same thing as the id method.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
164 Returntype : string
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
165 Exceptions : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
166 Caller : web drawing code
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
167
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
168 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
169
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
170 sub display_name {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
171 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
172 return $self->id();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
173 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
174
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
175
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
176
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
177 1;