| 1 | # | ||
| 2 | # BioPerl module for Bio::SeqFeature::Gene::ExonI | ||
| 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::ExonI - Interface for a feature representing an exon | ||
| 17 | |||
| 18 | =head1 SYNOPSIS | ||
| 19 | |||
| 20 | See documentation of methods. | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | A feature representing an exon. An exon in this definition is | ||
| 25 | transcribed and at least for one particular transcript not spliced out | ||
| 26 | of the pre-mRNA. However, it does not necessarily code for amino acid. | ||
| 27 | |||
| 28 | =head1 FEEDBACK | ||
| 29 | |||
| 30 | =head2 Mailing Lists | ||
| 31 | |||
| 32 | User feedback is an integral part of the evolution of this | ||
| 33 | and other Bioperl modules. Send your comments and suggestions preferably | ||
| 34 | to one of the Bioperl mailing lists. | ||
| 35 | Your participation is much appreciated. | ||
| 36 | |||
| 37 | bioperl-l@bioperl.org - General discussion | ||
| 38 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||
| 39 | |||
| 40 | =head2 Support | ||
| 41 | |||
| 42 | Please direct usage questions or support issues to the mailing list: | ||
| 43 | |||
| 44 | I<bioperl-l@bioperl.org> | ||
| 45 | |||
| 46 | rather than to the module maintainer directly. Many experienced and | ||
| 47 | reponsive experts will be able look at the problem and quickly | ||
| 48 | address it. Please include a thorough description of the problem | ||
| 49 | with code and data examples if at all possible. | ||
| 50 | |||
| 51 | =head2 Reporting Bugs | ||
| 52 | |||
| 53 | Report bugs to the Bioperl bug tracking system to help us keep track | ||
| 54 | the bugs and their resolution. Bug reports can be submitted via the | ||
| 55 | web: | ||
| 56 | |||
| 57 | https://github.com/bioperl/bioperl-live/issues | ||
| 58 | |||
| 59 | =head1 AUTHOR - Hilmar Lapp | ||
| 60 | |||
| 61 | Email hlapp@gmx.net | ||
| 62 | |||
| 63 | =head1 APPENDIX | ||
| 64 | |||
| 65 | The rest of the documentation details each of the object methods. | ||
| 66 | Internal methods are usually preceded with a _ | ||
| 67 | |||
| 68 | =cut | ||
| 69 | |||
| 70 | |||
| 71 | # Let the code begin... | ||
| 72 | |||
| 73 | |||
| 74 | package Bio::SeqFeature::Gene::ExonI; | ||
| 75 | 28 | $Bio::SeqFeature::Gene::ExonI::VERSION = '1.7.8'; | |
| 76 | 28 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 77 | |||
| 78 | 28 | ▶ | use base qw(Bio::SeqFeatureI); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 79 | |||
| 80 | |||
| 81 | =head2 is_coding | ||
| 82 | |||
| 83 | Title : is_coding | ||
| 84 | Usage : if($exon->is_coding()) { | ||
| 85 | # do something | ||
| 86 | } | ||
| 87 | Function: Whether or not the exon codes for amino acid. | ||
| 88 | Returns : TRUE if the object represents a feature translated into protein, | ||
| 89 | and FALSE otherwise. | ||
| 90 | Args : | ||
| 91 | |||
| 92 | |||
| 93 | =cut | ||
| 94 | |||
| 95 | 0 | ▶ | sub is_coding { |
|
Subroutine
is_coding: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 96 | 0 | my ($self) = @_; | |
| 97 | 0 | $self->throw_not_implemented(); | |
| 98 | } | ||
| 99 | |||
| 100 | =head2 cds | ||
| 101 | |||
| 102 | Title : cds() | ||
| 103 | Usage : $cds = $exon->cds(); | ||
| 104 | Function: Get the coding sequence of the exon as a sequence object. | ||
| 105 | |||
| 106 | The returned sequence object must be in frame 0, i.e., the first | ||
| 107 | base starts a codon. | ||
| 108 | |||
| 109 | An implementation may return undef, indicating that a coding | ||
| 110 | sequence does not exist, e.g. for a UTR (untranslated region). | ||
| 111 | |||
| 112 | Returns : A L<Bio::PrimarySeqI> implementing object. | ||
| 113 | Args : | ||
| 114 | |||
| 115 | |||
| 116 | =cut | ||
| 117 | |||
| 118 | 0 | ▶ | sub cds { |
|
Subroutine
cds: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 119 | 0 | my ($self) = @_; | |
| 120 | 0 | $self->throw_not_implemented(); | |
| 121 | } | ||
| 122 | |||
| 123 | 28 | 1; | |