Bio/LiveSeq/Intron.pm

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