annotate variant_effect_predictor/Bio/EnsEMBL/UnconventionalTranscriptAssociation.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::UnconventionalTranscriptAssociation - A class representing
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 an some sort of unconventional association between a gene and a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25 transcript.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 $ex = new Bio::EnsEMBL::UnconventionalTranscriptAssociation( $gene,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 $transcript, $type );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 package Bio::EnsEMBL::UnconventionalTranscriptAssociation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 use Bio::EnsEMBL::Utils::Exception qw( warning throw deprecate );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 use Bio::EnsEMBL::Utils::Argument qw( rearrange );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 =head2 new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 Args [1] : Bio::EnsEMBL::Gene - the gene which is associated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 Args [2] : Bio::EnsEMBL::Transcript - the transcript which is associated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 Args [3] : String type - the type of assocation, e.g. "antisense",
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 "sense_intronic","sense_overlaping_exonic","chimeric_sense_exonic".
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 Example : $uta = new Bio::EnsEMBL::UnconventionalTranscriptAssociation($gene, $transcript, "antisense")
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 Description: create an UnconventionalTranscriptAssociation object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 Returntype : Bio::EnsEMBL::UnconventionalTranscriptAssociation.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 Exceptions : Wrong argument types
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 Status : At risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 my ($class, $transcript, $gene, $type) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 $class = ref $class || $class;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 my $self = {};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 if( !ref $gene || ! $gene->isa("Bio::EnsEMBL::Gene") ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 throw("$gene is not a Bio::EnsEMBL::Gene!");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 if( !ref $transcript || ! $transcript->isa("Bio::EnsEMBL::Transcript") ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 throw("$transcript is not a Bio::EnsEMBL::Transcript!");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 $self->{'gene'} = $gene;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 $self->{'transcript'} = $transcript;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 $self->{'type'} = $type;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 return bless $self, $class;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 =head2 gene
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 Example : $gene = $uta->gene()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 Description: Getter/setter for the gene part of this association.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 Returntype : Bio::EnsEMBL::Gene
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 Status : At risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 sub gene {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 my ($self) = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 $self->{'gene'} = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 return $self->{'gene'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 =head2 transcript
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 Example : $transcript = $uta->transcript()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 Description: Getter/setter for the transcript part of this association.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 Returntype : Bio::EnsEMBL::Transcript
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 Caller : General
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 Status : At risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 sub transcript {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 my ($self) = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 $self->{'transcript'} = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 return $self->{'transcript'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 =head2 interaction_type
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 Example : $type = $uta->interaction_type()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 Description: Getter/setter for the interaction_type of this association.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127 Returntype : String
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 Caller : General
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 Status : At risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134 sub interaction_type {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 my ($self) = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137 $self->{'interaction_type'} = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 return $self->{'interaction_type'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144