Bio::Search GenericStatistics
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Search::GenericStatistics - An object for statistics
Package variables
No package variables defined.
Inherit
Bio::Root::Root Bio::Search::StatisticsI
Synopsis
  my $void   = $obj->set_statistic("statistic_name","statistic_value"); 
  my $value  = $obj->get_statistic("statistic_name");
Description
This is a basic container to hold the statistics returned from a program.
Methods
new
No description
Code
get_statisticDescriptionCode
set_statisticDescriptionCode
available_statisticsDescriptionCode
Methods description
get_statisticcode    nextTop
 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
set_statisticcodeprevnextTop
 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
available_statisticscodeprevnextTop
 Title   : available_statistics
 Usage   : my @statnames = $statistic_object->available_statistics
 Function: Returns the names of the available statistics
 Returns : list of available statistic names
 Args    : none
Methods code
newdescriptionprevnextTop
sub new {
    my ($class, @args) = @_;
    my $self = $class->SUPER::new(@args);
    return $self;
}
get_statisticdescriptionprevnextTop
sub get_statistic {
    my ($self,$arg) = @_;
    return $self->{stats}->{$arg};
}
set_statisticdescriptionprevnextTop
sub set_statistic {
    my ($self,$name,$value) = @_;
    $self->{stats}->{$name} = $value;
}
available_statisticsdescriptionprevnextTop
sub available_statistics {
    my $self = shift;
    return keys %{$self->{stats}};
}
General documentation
FEEDBACKTop
Mailing ListsTop
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
Reporting BugsTop
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/
AUTHOR - Chad MatsallaTop
Email bioinformatics1 at dieselwurks dot com
CONTRIBUTORSTop
Sendu Bala, bix@sendu.me.uk
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _