NAME

Bio::Search::StatisticsI - A Base object for statistics

SYNOPSIS

# do not use this object directly, it provides the following methods
# for its subclasses

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.

FEEDBACK

Mailing Lists

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

Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

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:

https://github.com/bioperl/bioperl-live/issues

AUTHOR - Chad Matsalla

Email bioinformatics1 at dieselwurks dot com

APPENDIX

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

get_statistic

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_statistic

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