annotate variant_effect_predictor/Bio/EnsEMBL/SeqFeatureI.pm @ 0:21066c0abaf5 draft

Uploaded
author willmclaren
date Fri, 03 Aug 2012 10:04:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 =head1 LICENSE
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 This software is distributed under a modified Apache license.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 For license details, please see
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 =head1 CONTACT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 <helpdesk@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 Bio::EnsEMBL::SeqFeatureI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 Do not use this class. It is deprecated and has been replaced by
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 Bio::EnsEMBL::Feature.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 =head1 METHODS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 package Bio::EnsEMBL::SeqFeatureI;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 use Carp;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 # Object preamble - inherits from Bio::Root::Object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 use Bio::SeqFeatureI;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 use Bio::EnsEMBL::Root;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 @ISA = qw(Bio::EnsEMBL::Root Bio::SeqFeatureI);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 =head1 Abstract methods
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 These methods must be implemented in all subclasses.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 =head2 analysis
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 Title : analysis
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 Usage : $sf->analysis();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 Function: Store details of the program/database
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 and versions used to create this feature.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 sub analysis {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 my ($self,$value) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 $self->throw("Have not implemeneted analysis");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 =head2 validate
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 Title : validate
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 Usage : $sf->validate;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 Function: Checks whether all the data is present in the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 sub validate {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 my ($self,$value) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 $self->throw("Have not implemeneted validate");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 sub id {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 my ($self,$value) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 $self->throw("Have not implemented id");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 =head2 percent_id
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 Title : percent_id
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 Usage : $pid = $feat->percent_id()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 $feat->percent_id($pid)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 Function: get/set on percentage identity information
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 Returns : float
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 Args : none if get, the new value if set
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 sub percent_id {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 $self->throw("percent_id() not yet implemented");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 =head2 e_value
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 Title : p_value
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 Usage : $p_val = $feat->p_value()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 $feat->p_value($p_val)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 Function: get/set on p value information
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 Returns : float
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 Args : none if get, the new value if set
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 sub e_value {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 $self->throw("e value() not yet implemented");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 =head2 phase
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 Title : phase
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 Usage : $phase = $feat->phase()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 $feat->phase($phase)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 Function: get/set on start phase of predicted exon feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 Returns : [0,1,2]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 Args : none if get, 0,1 or 2 if set.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149 sub phase {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151 $self->throw("phase() not yet implemented");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154 =head2 end_phase
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156 Title : end_phase
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157 Usage : $end_phase = $feat->end_phase()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
158 $feat->end_phase($end_phase)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
159 Function: get/set on end phase of predicted exon feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
160 Returns : [0,1,2]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
161 Args : none if get, 0,1 or 2 if set.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
162
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
163 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
164
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
165 sub end_phase {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
166 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
167 $self->throw("end_phase() not yet implemented");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
168 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
169
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
170
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
171 # this is a bit too sneaky.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
172 sub location {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
173 my ($self)= @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
174 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
175 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
176
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
177
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
178 1;