annotate variant_effect_predictor/Bio/SeqFeature/Gene/GeneStructureI.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 # $Id: GeneStructureI.pm,v 1.8 2002/10/22 07:38:41 lapp Exp $
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::SeqFeature::Gene::GeneStructureI
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5 # Cared for by Hilmar Lapp <hlapp@gmx.net>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 # Copyright Hilmar Lapp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 # POD documentation - main docs before the code
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15 Bio::SeqFeature::Gene::GeneStructure - A feature representing an arbitrarily
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 complex structure of a gene
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20 #documentaion needed
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 A feature representing a gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 =head1 FEEDBACK
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 =head2 Mailing Lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 User feedback is an integral part of the evolution of this
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 and other Bioperl modules. Send your comments and suggestions preferably
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 to one of the Bioperl mailing lists.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 Your participation is much appreciated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 bioperl-l@bioperl.org - General discussion
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 http://bio.perl.org/MailList.html - About the mailing lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 =head2 Reporting Bugs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 Report bugs to the Bioperl bug tracking system to help us keep track
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 the bugs and their resolution.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 Bug reports can be submitted via email or the web:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 bioperl-bugs@bio.perl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 http://bugzilla.bioperl.org/
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 =head1 AUTHOR - Hilmar Lapp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 Email hlapp@gmx.net
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 Describe contact details here
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 =head1 APPENDIX
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 The rest of the documentation details each of the object methods.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 Internal methods are usually preceded with a _
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 # Let the code begin...
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 package Bio::SeqFeature::Gene::GeneStructureI;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 use Carp;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 use Bio::SeqFeatureI;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 @ISA = qw(Bio::SeqFeatureI);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 =head2 transcripts
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 Title : transcripts()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 Usage : @transcripts = $gene->transcripts();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 Function: Get the transcript features/sites of this gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 See Bio::SeqFeature::Gene::TranscriptI for properties of the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 returned objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 Returns : An array of Bio::SeqFeature::Gene::TranscriptI implementing objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 representing the promoter regions or sites.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 Args :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 sub transcripts {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 =head2 promoters
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 Title : promoters()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 Usage : @prom_sites = $gene->promoters();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 Function: Get the promoter features/sites of this gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 Note that OO-modeling of regulatory elements is not stable yet.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 This means that this method might change or even disappear in a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 future release. Be aware of this if you use it.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 Returns : An array of Bio::SeqFeatureI implementing objects representing the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 promoter regions or sites.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 Args :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 sub promoters {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 =head2 exons
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 Title : exons()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 Usage : @exons = $gene->exons();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 @inital = $gene->exons('Initial');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 Function: Get all exon features or all exons of specified type of this gene
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121 structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 Refer to the documentation of the class that produced this gene
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 structure object for information about the possible types.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 See Bio::SeqFeature::Gene::ExonI for properties of the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127 returned objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 Returns : An array of Bio::SeqFeature::Gene::ExonI implementing objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 representing the exon regions.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 Args : An optional string specifying the type of the exon.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 sub exons {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136 my ($self, $type) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 =head2 introns
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142 Title : introns()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143 Usage : @introns = $gene->introns();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144 Function: Get all introns of this gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145 Returns : An array of Bio::SeqFeatureI implementing objects representing the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146 introns.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 Args :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152 sub introns {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157 =head2 poly_A_sites
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159 Title : poly_A_sites()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160 Usage : @polyAsites = $gene->poly_A_sites();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161 Function: Get the poly-adenylation features/sites of this gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162 Returns : An array of Bio::SeqFeatureI implementing objects representing the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163 poly-adenylation regions or sites.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 Args :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169 sub poly_A_sites {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174 =head2 utrs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176 Title : utrs()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 Usage : @utr_sites = $gene->utrs();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178 Function: Get the UTR features/sites of this gene structure.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180 See Bio::SeqFeature::Gene::ExonI for properties of the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181 returned objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183 Returns : An array of Bio::SeqFeature::Gene::ExonI implementing objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184 representing the UTR regions or sites.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185 Args :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
187
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
188 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
189
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
190 sub utrs {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
191 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
192 $self->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
193 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
194
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
195 1;