Bio::S...sticsI(3pm)

💖 Bio::S...sticsI 💖

okay bestie, so this page is from the User Contributed Perl Documentation collection, and it's filed under the manual name Bio::S...sticsI(3pm). yes the name is literally abbreviated like that, no I don't know why, we move on 💅

✨ NAME ✨

Bio::Search::StatisticsI — a base object for statistics. it's giving "foundation", it's giving "parent class energy" 🫶

---

🌸 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");

lowkey important: do not use this object directly, okay? it's not a main character, it's a supporting character. it exists to serve methods to its subclasses. respect the hierarchy bestie 👑

---

🦋 DESCRIPTION 🦋

this is a basic container to hold the statistics returned from a program. that's it, that's the whole vibe. a little bucket for numbers. a stats purse. a tiny treasure chest of data 🎀

---

💌 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, fr fr 🥹

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. (yes, the original says "reponsive" — we keep it exactly as it is, typos are heritage ✨)

🐛 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

(shoutout Chad, iconic behavior 💜)

---

🧚 APPENDIX 🧚

the rest of the documentation details each of the object methods. internal methods are usually preceded with a _ (iykyk, that underscore is the secret handshake 🤫)

💫 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

so basically: you hand it a name, it hands you back the value. give and take, mutual, balanced 🌈

⭐ 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

you pass in name => value pairs, it sets them, and it returns void — nothing, nada, zero, it simply does the thing and leaves 💅

---

and that's the whole page bestie!! this one was rendered by perl v5.32.1, dated 2021-08-15, under the manual name Bio::S...sticsI(3pm). go forth and containerize your statistics, you absolute genius 🎀💖✨