annotate variant_effect_predictor/Bio/EnsEMBL/SeqFeatureI.pm @ 3:d30fa12e4cc5 default tip

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