lib/Bio/Tools/Primer/AssessorI.pm

   1 # BioPerl module for Bio::Tools::Primer::AssessorI
   2 #
   3 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   4 #
   5 # Cared for by Ewan Birney <birney@ebi.ac.uk>
   6 #
   7 # Copyright Ewan Birney
   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::Tools::Primer::AssessorI - interface for assessing primer pairs
  16
  17 =head1 SYNOPSIS
  18
  19     use Bio::Tools::Primer::AssessorI;
  20
  21     if( $obj->isa('Bio::Tools::Primer::AssessorI') ) {
  22         my $score = $obj->assess($primer_pair);
  23     }
  24
  25
  26 =head1 DESCRIPTION
  27
  28 The Primer Assessor interface provides a interface for scoring
  29 functions of primer pairs to comply to. It is mainly used by
  30 Bio::Tools::Primer::Design module
  31
  32 =head1 FEEDBACK
  33
  34 =head2 Mailing Lists
  35
  36 User feedback is an integral part of the evolution of this and other
  37 Bioperl modules. Send your comments and suggestions preferably to
  38 the Bioperl mailing list.  Your participation is much appreciated.
  39
  40   bioperl-l@bioperl.org                  - General discussion
  41   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  42
  43 =head2 Support
  44
  45 Please direct usage questions or support issues to the mailing list:
  46
  47 I<bioperl-l@bioperl.org>
  48
  49 rather than to the module maintainer directly. Many experienced and
  50 reponsive experts will be able look at the problem and quickly
  51 address it. Please include a thorough description of the problem
  52 with code and data examples if at all possible.
  53
  54 =head2 Reporting Bugs
  55
  56 Report bugs to the Bioperl bug tracking system to help us keep track
  57 of the bugs and their resolution. Bug reports can be submitted via the
  58 web:
  59
  60   https://github.com/bioperl/bioperl-live/issues
  61
  62 =head1 AUTHOR - Ewan Birney
  63
  64 Email birney-at-ebi.ac.uk
  65
  66 =head1 APPENDIX
  67
  68 The rest of the documentation details each of the object methods.
  69 Internal methods are usually preceded with a _
  70
  71 =cut
  72
  73
  74 # Let the code begin...
  75
  76 package Bio::Tools::Primer::AssessorI;
  77
  78
  79
  80 use base qw(Bio::Root::RootI);
  81
  82 sub assess {
  83     my ($self) = shift;
  84     $self->throw_not_implemented();
  85 }
  86
  87 1;