Bio/SeqFeature/Gene/GeneStructureI.pm

filter: Statementstmt 47.8% 11 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 33.3% 3 / 9 Podpod 100% 6 / 6 totaltotal 52.6% 20 / 38 CC 1 SCAR 5.1
CC
1
Cov
48%
transcripts
2.0
promoters
2.0
exons
2.0
CRAP 1.7
« Bio/DB/UpdateableSeqI.pm ↑ Summary Bio/Search/DatabaseI.pm »
1 #
2 # BioPerl module for Bio::SeqFeature::Gene::GeneStructureI
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Hilmar Lapp <hlapp@gmx.net>
7 #
8 # Copyright Hilmar Lapp
9 #
10 # You may distribute this module under the same terms as perl itself
11  
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::SeqFeature::Gene::GeneStructureI - A feature representing an arbitrarily
17 complex structure of a gene
18  
19 =head1 SYNOPSIS
20  
21 #documentation needed
22  
23 =head1 DESCRIPTION
24  
25 A feature representing a gene structure.
26  
27 =head1 FEEDBACK
28  
29 =head2 Mailing Lists
30  
31 User feedback is an integral part of the evolution of this
32 and other Bioperl modules. Send your comments and suggestions preferably
33 to one of the Bioperl mailing lists. Your participation is much appreciated.
34  
35 bioperl-l@bioperl.org - General discussion
36 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
37  
38 =head2 Support
39  
40 Please direct usage questions or support issues to the mailing list:
41  
42 I<bioperl-l@bioperl.org>
43  
44 rather than to the module maintainer directly. Many experienced and
45 reponsive experts will be able look at the problem and quickly
46 address it. Please include a thorough description of the problem
47 with code and data examples if at all possible.
48  
49 =head2 Reporting Bugs
50  
51 Report bugs to the Bioperl bug tracking system to help us keep track
52 the bugs and their resolution. Bug reports can be submitted via the
53 web:
54  
55 https://github.com/bioperl/bioperl-live/issues
56  
57 =head1 AUTHOR - Hilmar Lapp
58  
59 Email hlapp@gmx.net
60  
61 =head1 APPENDIX
62  
63 The rest of the documentation details each of the object methods.
64 Internal methods are usually preceded with a _
65  
66 =cut
67  
68  
69 # Let the code begin...
70  
71  
72 package Bio::SeqFeature::Gene::GeneStructureI;
73 15 $Bio::SeqFeature::Gene::GeneStructureI::VERSION = '1.7.8';
74 15 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
75  
76 15 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
77  
78 15 ▶use base qw(Bio::SeqFeatureI);
Subroutine BEGIN: called CC=1 SCAR=0.0
79  
80 =head2 transcripts
81  
82 Title : transcripts()
83 Usage : @transcripts = $gene->transcripts();
84 Function: Get the transcript features/sites of this gene structure.
85  
86 See Bio::SeqFeature::Gene::TranscriptI for properties of the
87 returned objects.
88  
89 Returns : An array of Bio::SeqFeature::Gene::TranscriptI implementing objects
90 representing the promoter regions or sites.
91 Args :
92  
93  
94 =cut
95  
96 0 ▶sub transcripts {
Subroutine transcripts: not called CC=1 SCAR=6.9
Pod documented
97 0 my ($self) = @_;
98 0 $self->throw_not_implemented();
99 }
100  
101 =head2 promoters
102  
103 Title : promoters()
104 Usage : @prom_sites = $gene->promoters();
105 Function: Get the promoter features/sites of this gene structure.
106  
107 Note that OO-modeling of regulatory elements is not stable yet.
108 This means that this method might change or even disappear in a
109 future release. Be aware of this if you use it.
110  
111 Returns : An array of Bio::SeqFeatureI implementing objects representing the
112 promoter regions or sites.
113 Args :
114  
115 =cut
116  
117 0 ▶sub promoters {
Subroutine promoters: not called CC=1 SCAR=6.9
Pod documented
118 0 my ($self) = @_;
119 0 $self->throw_not_implemented();
120 }
121  
122 =head2 exons
123  
124 Title : exons()
125 Usage : @exons = $gene->exons();
126 @inital = $gene->exons('Initial');
127 Function: Get all exon features or all exons of specified type of this gene
128 structure.
129  
130 Refer to the documentation of the class that produced this gene
131 structure object for information about the possible types.
132  
133 See Bio::SeqFeature::Gene::ExonI for properties of the
134 returned objects.
135  
136 Returns : An array of Bio::SeqFeature::Gene::ExonI implementing objects
137 representing the exon regions.
138 Args : An optional string specifying the type of the exon.
139  
140 =cut
141  
142 0 ▶sub exons {
Subroutine exons: not called CC=1 SCAR=6.9
Pod documented
143 0 my ($self, $type) = @_;
144 0 $self->throw_not_implemented();
145 }
146  
147 =head2 introns
148  
149 Title : introns()
150 Usage : @introns = $gene->introns();
151 Function: Get all introns of this gene structure.
152 Returns : An array of Bio::SeqFeatureI implementing objects representing the
153 introns.
154 Args :
155  
156  
157 =cut
158  
159 0 ▶sub introns {
Subroutine introns: not called CC=1 SCAR=6.9
Pod documented
160 0 my ($self) = @_;
161 0 $self->throw_not_implemented();
162 }
163  
164 =head2 poly_A_sites
165  
166 Title : poly_A_sites()
167 Usage : @polyAsites = $gene->poly_A_sites();
168 Function: Get the poly-adenylation features/sites of this gene structure.
169 Returns : An array of Bio::SeqFeatureI implementing objects representing the
170 poly-adenylation regions or sites.
171 Args :
172  
173  
174 =cut
175  
176 0 ▶sub poly_A_sites {
Subroutine poly_A_sites: not called CC=1 SCAR=6.9
Pod documented
177 0 my ($self) = @_;
178 0 $self->throw_not_implemented();
179 }
180  
181 =head2 utrs
182  
183 Title : utrs()
184 Usage : @utr_sites = $gene->utrs();
185 Function: Get the UTR features/sites of this gene structure.
186  
187 See Bio::SeqFeature::Gene::ExonI for properties of the
188 returned objects.
189  
190 Returns : An array of Bio::SeqFeature::Gene::ExonI implementing objects
191 representing the UTR regions or sites.
192 Args :
193  
194  
195 =cut
196  
197 0 ▶sub utrs {
Subroutine utrs: not called CC=1 SCAR=6.9
Pod documented
198 0 my ($self) = @_;
199 0 $self->throw_not_implemented();
200 }
201  
202 15 1;
« Bio/DB/UpdateableSeqI.pm ↑ Summary Bio/Search/DatabaseI.pm »