Summary

Bio::Search::BlastStatistics - An object for Blast statistics

Package variables

Inherit

Bio::Root::RootI Bio::Search::StatisticsI

Synopsis

          # this is a wrapper to hold the statistics from a Blast report
     my $bs = $result->get_statistics();
          # you can get a statistic generically, like this:
     my $kappa  = $bs->get_statistic("kappa");
          # or specifically, like this:
     my $kappa2 = $bs->get_kappa();

Description

This is a basic container to hold the statistics returned from a Blast.

Methods

Methods description

 Title   : get_statistic
 Usage   : $statistic_object->get_statistic($statistic_name);
 Function: Get the value of a statistic named $statistic_name
 Returns : A scalar that should be a string
 Args    : A scalar that should be a string

 Title   : set_statistic
 Usage   : $statistic_object->set_statistic($statistic_name => $statistic_value);
 Function: Set the value of a statistic named $statistic_name to $statistic_value
 Returns : Void
 Args    : A hash containing name=>value pairs

Methods code

sub new {

    my ($class, @args) = @_; 
          # really, don't bother with any initial initialization
    my $self = $class->SUPER::new(@args);
    return $self;

}

sub get_statistic {

   my ($self,$arg) = @_;
     return $self->{$arg};

}

sub set_statistic {

   my ($self,%args) = @_;
     foreach (keys %args) {
          $self->{$_} = $args{$_};
     }

}

General documentation

User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.

  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:

  http://bugzilla.open-bio.org/

Email bioinformatics1 at dieselwurks dot com

The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _