Bio/LiveSeq/Intron.pm

   1 # $Id$
   2 #
   3 # bioperl module for Bio::LiveSeq::Intron
   4 #
   5 # Cared for by Joseph Insana <insana@ebi.ac.uk> <jinsana@gmx.net>
   6 #
   7 # Copyright Joseph Insana
   8 #
   9 # You may distribute this module under the same terms as perl itself
  10 #
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::LiveSeq::Intron - Range abstract class for LiveSeq
  16
  17 =head1 SYNOPSIS
  18
  19   # documentation needed
  20
  21 =head1 DESCRIPTION
  22
  23 Class for INTRON objects. They consist of a beginlabel, an endlabel (both
  24 referring to a LiveSeq DNA object) and a strand.
  25 The strand could be 1 (forward strand, default), -1 (reverse strand).
  26
  27 =head1 AUTHOR - Joseph A.L. Insana
  28
  29 Email:  Insana@ebi.ac.uk, jinsana@gmx.net
  30
  31 =head1 APPENDIX
  32
  33 The rest of the documentation details each of the object
  34 methods. Internal methods are usually preceded with a _
  35
  36 =cut
  37
  38 # Let the code begin...
  39
  40 package Bio::LiveSeq::Intron;
  41
  42 use strict;
  43 use base qw(Bio::LiveSeq::Range);
  44
  45 =head2 new
  46
  47   Title   : new
  48   Usage   : $intron1=Bio::LiveSeq::Intron->new(-seq => $objref,
  49                                                -start => $startlabel,
  50                                                -end => $endlabel,
  51                                                -strand => 1
  52                                                );
  53
  54   Function: generates a new Bio::LiveSeq::Intron
  55   Returns : reference to a new object of class Intron
  56   Errorcode -1
  57   Args    : two labels and an integer
  58
  59 =cut
  60
  61 1;