annotate variant_effect_predictor/Bio/EnsEMBL/AssemblyExceptionFeature.pm @ 0:1f6dce3d34e0

Uploaded
author mahtabm
date Thu, 11 Apr 2013 02:01:53 -0400
parents
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::AssemblyExceptionFeature - A feature that represents an assembly exception
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 use Bio::EnsEMBL::AssemblyExceptionFeature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 $feature = Bio::EnsEMBL::AssemblyExceptionFeature->new(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 -start => 100,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 -end => 220,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 -type => 'HAP',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 -slice => $slice,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 -adaptor => $adaptor
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 Certain features, e.g. Haplotypes and PARs, are represented as
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 "exceptions" to the normal assembly. This class represents such
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 features.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 package Bio::EnsEMBL::AssemblyExceptionFeature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 use Bio::EnsEMBL::Feature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 use Scalar::Util qw(weaken isweak);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 @ISA = qw(Bio::EnsEMBL::Feature);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 =head2 new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 Arg [TYPE] : The type (e.g. HAP for haplotype, PAR for PAR)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 Arg [...] : Named arguments passed to superclass
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 Example : $feature = Bio::EnsEMBL::AssemblyExceptionFeature->new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 (-start => 1,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 -end => 100,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 -slice => $slice,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 -alternate_slice => $alt_slice,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 -adaptor => $adaptor,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 -type => 'HAP')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 Description: Constructs a new Bio::EnsEMBL::Feature. Generally subclasses
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 of this method are instantiated, rather than this class itself.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 Returntype : Bio::EnsEMBL::Feature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 Exceptions : Thrown on invalid -SLICE arguments
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 Caller : general, subclass constructors
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 my $caller = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 # allow this to be called as class or object method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 my $class = ref($caller) || $caller;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 my $self = $class->SUPER::new(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 my ($type, $alternate_slice) = rearrange(['TYPE', 'ALTERNATE_SLICE'],@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 $self->{'type'} = $type;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 $self->{'alternate_slice'} = $alternate_slice;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 =head2 new_fast
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 Arg [1] : hashref to be blessed
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 Description: Construct a new Bio::EnsEMBL::Feature using the hashref.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 Returntype : Bio::EnsEMBL::Feature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 Caller : general, subclass constructors
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 sub new_fast {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 my $class = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 my $hashref = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 my $self = bless $hashref, $class;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 weaken($self->{adaptor}) if ( ! isweak($self->{adaptor}) );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 =head2 type
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 Arg [1] : (optional) string $value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 Example : $type = $assembly_exception_feature->type();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 Description: Getter/Setter for the type associated with this
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 feature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121 Returntype : string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 sub type {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132 $self->{'type'} = shift if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134 return $self->{'type'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 =head2 alternate_slice
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 Arg [1] : (optional) string $value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141 Example : $alt_slice = $assembly_exception_feature->alternate_slice();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142 Description: Getter/Setter for the alternate slice associated with this feature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143 The alternate slice represents the "other side" of the AssemblyExceptionFeature.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144 Returntype : Bio::EnsEMBL::Slice
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151 sub alternate_slice {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 $self->{'alternate_slice'} = shift if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157 return $self->{'alternate_slice'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162 =head2 display_id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 Arg [1] : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165 Example : print $aef->display_id();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166 Description: This method returns a string that is considered to be
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167 the 'display' identifier. For assembly exception features
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168 this is the name of the alternate seqregion or '' if the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169 alternate slice is not defined.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 Returntype : string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172 Caller : web drawing code
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 sub display_id {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179 my $slice = $self->{'alternate_slice'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180 return '' if(!$slice);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181 return $slice->seq_region_name();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186 1;