annotate variant_effect_predictor/Bio/EnsEMBL/Root.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 =head1 AUTHOR
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 Originally from Steve Chervitz. Refactored by Ewan Birney.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27 Bio::EnsEMBL::Root
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31 Do not use Bio::EnsEMBL::Root anymore. It is included for backwards
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 compatibility (every object in EnsEMBL used to inherit from this class)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 but will eventually be phased out. The replacement for the _rearrage
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34 method is the rearrange method which can be imported in the following
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 way:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39 # can now call rearrange as a class method (instead as object method)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 my ( $start, $end ) = rearrange( [ 'START', 'END' ], @args );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 If you want to use the throw or warn methods the replacement use the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43 class methods throw and warning from the Bio::EnsEMBL::Utils::Exception
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44 class:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46 use Bio::EnsEMBL::Utils::Exception qw(throw warning);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48 # can now call throw or warning even without blessed reference
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 warning('This is a warning');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50 throw('This is an exception');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 This module was stolen from BioPerl to avoid problems with moving to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53 BioPerl 1 from 0.7
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55 =head1 METHODS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59 package Bio::EnsEMBL::Root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 use vars qw($VERBOSITY);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63 use Bio::EnsEMBL::Utils::Exception qw( );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 use Bio::EnsEMBL::Utils::Argument qw( );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67 $VERBOSITY = 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 sub new{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70 my($caller,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 my $class = ref($caller) || $caller;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73 return bless({}, $class);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 =head2 throw
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 sub throw{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 my ($self,$string) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 Bio::EnsEMBL::Utils::Exception->warning("\n------------------ DEPRECATED ---------------------\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87 "Bio::EnsEMBL::Root::throw has been deprecated\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88 "use Bio::EnsEMBL::Utils::Exception qw(throw); \n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89 "throw('message'); #instead\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 "\n---------------------------------------------------\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 Bio::EnsEMBL::Utils::Exception->throw($string);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 =head2 warn
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 sub warn{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 my ($self,$string) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 Bio::EnsEMBL::Utils::Exception->warning("\n------------------ DEPRECATED ---------------------\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 "Bio::EnsEMBL::Root::warn has been deprecated\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 "use Bio::EnsEMBL::Utils::Exception qw(warning); \n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111 "warning('message'); #instead\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112 "\n---------------------------------------------------\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114 Bio::EnsEMBL::Utils::Exception->warning($string);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121 =head2 verbose
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 sub verbose{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 my ($self,$value) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 Bio::EnsEMBL::Utils::Exception->warning("\n------------------ DEPRECATED ---------------------\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131 "Bio::EnsEMBL::Root::verbose has been deprecated\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132 "use Bio::EnsEMBL::Utils::Exception qw(verbose); \n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 "verbose(value); #instead\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 "\n---------------------------------------------------\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 Bio::EnsEMBL::Utils::Exception->verbose($value);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 =head2 stack_trace_dump
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 sub stack_trace_dump{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 Bio::EnsEMBL::Utils::Exception->warning("\n------------------ DEPRECATED ---------------------\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150 "Bio::EnsEMBL::Root::stack_trace_dump has been deprecated\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 "use Bio::EnsEMBL::Utils::Exception qw(stack_trace_dump); \n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152 "stack_trace_dump(); #instead\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153 "\n---------------------------------------------------\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155 Bio::EnsEMBL::Utils::Exception->stack_trace_dump();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 =head2 stack_trace
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
162 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
163
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
164 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
165
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
166 sub stack_trace{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
167 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
168
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
169 Bio::EnsEMBL::Utils::Exception->warning("\n------------------ DEPRECATED ---------------------\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
170 "Bio::EnsEMBL::Root::stack_trace has been deprecated\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
171 "use Bio::EnsEMBL::Utils::Exception qw(stack_trace); \n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
172 "stack_trace(); #instead\n".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
173 "\n---------------------------------------------------\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
174
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
175 Bio::EnsEMBL::Utils::Exception->stack_trace();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
176
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
177 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
178
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
179
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
180 =head2 _rearrange
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
181
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
182 DEPRECATED
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
183
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
184 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
185
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
186 #----------------'
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
187 sub _rearrange {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
188 #----------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
189 my($self,$order,@param) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
190
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
191 my $mess = "use Bio::EnsEMBL::Utils::Argument qw(rearrange); \n";
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
192 $mess .= "rearrange(order, list); #instead\n";
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
193
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
194 Bio::EnsEMBL::Utils::Exception->deprecate($mess);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
195
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
196 return Bio::EnsEMBL::Utils::Argument->rearrange($order,@param);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
197
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
198 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
199
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
200 1;