annotate variant_effect_predictor/Bio/EnsEMBL/SplicingEvent.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
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 =head1 LICENSE
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 Copyright (c) 1999-2012 The European Bioinformatics Institute and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 Genome Research Limited. All rights reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 This software is distributed under a modified Apache license.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 For license details, please see
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10 http://www.ensembl.org/info/about/code_licence.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12 =head1 CONTACT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 Please email comments or questions to the public Ensembl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15 developers list at <dev@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 Questions may also be sent to the Ensembl help desk at
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18 <helpdesk@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 Bio::EnsEMBL::SlicingEvent - Object representing an alternative splicing event
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 my $ase =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 Bio::EnsEMBL::SplicingEvent->new( -START => 123,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 -END => 1045,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 -STRAND => 1,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 -GENE_ID => $gene->dbID,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 -SLICE => $slice );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 # set some additional attributes
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 $ase->name('ENSG00000000003-CNE-3');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37 $ase->type('CNE');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 A representation of an Alternative Splicing Event within the Ensembl system.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 =head1 METHODS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 package Bio::EnsEMBL::SplicingEvent;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 use POSIX;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 use Bio::EnsEMBL::Feature;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 use Bio::EnsEMBL::Utils::Exception qw(throw warning deprecate);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 @ISA = qw(Bio::EnsEMBL::Feature);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 ## Add to gene get_all_splicing_events
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 sub gene_id {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 if ( defined($value) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 $self->{'gene_id'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 return $self->{'gene_id'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 sub name {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 if ( defined($value) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 $self->{'name'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 return $self->{'name'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 sub type {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 if ( defined($value) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 $self->{'type'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 return $self->{'type'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 sub add_Feature {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 my ( $self, $feature ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 if ( !ref($feature)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 || !$feature->isa("Bio::EnsEMBL::SplicingEventFeature") )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 throw("$feature is not a Bio::EnsEMBL::SplicingEventFeature!");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 $self->{'_feature_array'} ||= [];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 push( @{ $self->{'_feature_array'} }, $feature );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 sub get_all_Features {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 if ( !exists( $self->{'_feature_array'} ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 if ( defined( $self->adaptor() ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 my $fta =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 $self->adaptor()->db()->get_SplicingEventFeatureAdaptor();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 my $features = $fta->fetch_all_by_SplicingEvent($self);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 $self->{'_feature_array'} = $features;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 return $self->{'_feature_array'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 sub add_Pair {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 my ( $self, $feature ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 if ( !ref($feature)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 || !$feature->isa("Bio::EnsEMBL::SplicingEventPair") )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 throw("$feature is not a Bio::EnsEMBL::SplicingEventPair!");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 $self->{'_pair_array'} ||= [];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 push( @{ $self->{'_pair_array'} }, $feature );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 sub get_all_Pairs {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137 if ( !exists( $self->{'_pair_array'} ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 if ( defined( $self->adaptor() ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139 my $pa =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 $self->adaptor()->db()->get_SplicingTranscriptPairAdaptor();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 my $pairs = $pa->fetch_all_by_SplicingEvent($self);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 $self->{'_pair_array'} = $pairs;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146 return $self->{'_pair_array'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149 1;