File Coverage

blib/lib/GenOO/Intron.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

# POD documentation - main docs before the code

=head1 NAME

GenOO::Intron - Intron object

=head1 SYNOPSIS

    # This object represents an intron of a transcript
    # It extends the L<GenOO::GenomicRegion> object

    # To initialize
    GenOO::Intron->new(
        species      => undef,
        strand       => undef,           #required
        chromosome   => undef,           #required
        start        => undef,           #required
        stop         => undef,           #required
        part_of      => reference to a transcript object
    );

=head1 DESCRIPTION

    The intron class describes an intron of a transcript.
    It requires a strand (1,-1), a chromosome name, a genomic start and stop position (start is always the
    smallest coordinate in the genome and NOT the 5p of the intron - i.e. if the intron is in the -1 strand
    the start coordinate will be the 3p of the intron)
    See L<GenOO::Region> and for more available methods

=head1 EXAMPLES

    my $intron = GenOO::Intron->new(
        strand       => 1,                 #required
        chromosome   => 'chr11',           #required
        start        => 8893144,           #required
        stop         => 8911139,           #required
    );
   my $intron_start = $intron->start; #8893144

=cut

# Let the code begin...

package GenOO::Intron;
$GenOO::Intron::VERSION = '1.5.1';
use Moose;
use namespace::autoclean;

extends 'GenOO::GenomicRegion';

has 'part_of' => (is => 'rw', weak_ref => 1);


__PACKAGE__->meta->make_immutable;

1;