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