annotate variant_effect_predictor/Bio/EnsEMBL/SeqFeatureI.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::SeqFeatureI
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27 Do not use this class. It is deprecated and has been replaced by
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 Bio::EnsEMBL::Feature.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 =head1 METHODS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 # Let the code begin...
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38 package Bio::EnsEMBL::SeqFeatureI;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 use vars qw(@ISA);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 use Carp;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44 # Object preamble - inherits from Bio::Root::Object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46 use Bio::SeqFeatureI;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 use Bio::EnsEMBL::Root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 @ISA = qw(Bio::EnsEMBL::Root Bio::SeqFeatureI);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 =head1 Abstract methods
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 These methods must be implemented in all subclasses.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57 =head2 analysis
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59 Title : analysis
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 Usage : $sf->analysis();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61 Function: Store details of the program/database
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 and versions used to create this feature.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 Example :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65 Returns :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 Args :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71 sub analysis {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 my ($self,$value) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74 $self->throw("Have not implemeneted analysis");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 =head2 validate
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80 Title : validate
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 Usage : $sf->validate;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82 Function: Checks whether all the data is present in the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 object.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 Example :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85 Returns :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 Args :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91 sub validate {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 my ($self,$value) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 $self->throw("Have not implemeneted validate");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100 sub id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 my ($self,$value) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 $self->throw("Have not implemented id");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106 =head2 percent_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 Title : percent_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 Usage : $pid = $feat->percent_id()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 $feat->percent_id($pid)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111 Function: get/set on percentage identity information
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112 Returns : float
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113 Args : none if get, the new value if set
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117 sub percent_id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119 $self->throw("percent_id() not yet implemented");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122 =head2 e_value
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124 Title : p_value
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 Usage : $p_val = $feat->p_value()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 $feat->p_value($p_val)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 Function: get/set on p value information
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 Returns : float
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129 Args : none if get, the new value if set
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 sub e_value {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135 $self->throw("e value() not yet implemented");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138 =head2 phase
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 Title : phase
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 Usage : $phase = $feat->phase()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142 $feat->phase($phase)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 Function: get/set on start phase of predicted exon feature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 Returns : [0,1,2]
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145 Args : none if get, 0,1 or 2 if set.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 sub phase {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 $self->throw("phase() not yet implemented");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154 =head2 end_phase
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156 Title : end_phase
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157 Usage : $end_phase = $feat->end_phase()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158 $feat->end_phase($end_phase)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159 Function: get/set on end phase of predicted exon feature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 Returns : [0,1,2]
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161 Args : none if get, 0,1 or 2 if set.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
162
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
163 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
164
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
165 sub end_phase {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
166 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
167 $self->throw("end_phase() not yet implemented");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
168 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
169
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
170
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
171 # this is a bit too sneaky.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
172 sub location {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
173 my ($self)= @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
174 return $self;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
175 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
176
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
177
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
178 1;