Bio::T...nctions(3pm)

🎀 Bio::Tools::RandomDistFunctions 🎀

okay bestie, welcome to the perl side of the terminal 💅 this one lives in the perl manual pages (that's the 3pm energy, third section, module docs, iykyk) and it's genuinely so fun — it's a whole lil toolbox for making up random numbers that follow specific distributions. no cap.

---

✨ NAME ✨

Bio::Tools::RandomDistFunctions — a whole set of routines that are lowkey perfect for generating random data across different distributions 🎲✨

---

🦋 SYNOPSIS 🦋

use Bio::Tools::RandomDistFunctions;
my $dist = Bio::Tools::RandomDistFunctions->new();
for my $v ( 1..1000 ) {
  my $birth_dist = $dist->rand_birth_distribution($lambda);
  # ... do something with the variable
}

literally make an object, loop a thousand times, pull a random variable out each time, do your thing with it. that's the whole vibe 🫶

---

🌸 DESCRIPTION 🌸

most of this code is based on the C implementation of these routines over in Mike Sanderson's r8s package 🧚 if you wanna know more about his software, go look at http://loco.biosci.arizona.edu/r8s/ — that's the link, that's the source of the inspo.

---

💖 FEEDBACK 💖

📬 Mailing Lists

user feedback is integral to the evolution of this and every other Bioperl module — like, the whole thing grows because y'all talk to us 🫶 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 your usage questions and support issues to the mailing list:

bioperl-l@bioperl.org

...rather than sliding into the module maintainer's DMs directly 🙈 so many experienced and responsive experts are on that list and they'll be able to look at your problem and address it quickly. and bestie, please include a thorough description of the problem, with code and data examples if at all possible — it's giving "help us help you" energy 💅

🐛 Reporting Bugs

report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolutions — it's the whole point. bug reports can be submitted via the web at:

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

---

👑 AUTHOR - Jason Stajich 👑

Email jason-at-bioperl.org 📧

---

🌈 CONTRIBUTORS 🌈

big thank you to Mike Sanderson for the assistance in getting this implementation together 🫶 iconic behavior honestly.

---

⭐ APPENDIX ⭐

the rest of the documentation breaks down each of the object methods one by one, no skips, no skimming 🔍 internal methods are usually preceded with a _ (iykyk, that underscore is the "do not touch, this is private" signal 💀).

🍼 birth_distribution 🍼

• Title — rand_birth_distribution
• Usage — my $randvar = $dist->rand_birth_distribution($lambda);
• Function — returns a random number from a birth process waiting time with a fixed interval 1.0. times are measured from 0=present, 1=root.
• Returns — floating point number
• Args — $lambda ( > 0 )
• References — this is based on code by Mike Sanders in r8s. Ross, Stochastic Processes, p. 145 for the density.

🎲 rand_geometric_distribution 🎲

• Title — rand_geometric_distribution
• Usage — my $randvar = $dist->rand_geometric_distribution($param);
• Function — returns a random geometric variate distributed with parameter $param, according to the c.d.f. 1 - ( 1- param) ^ n
• Returns — integer
• Args — $param ( 0 > $param < 1 )

heads up bestie, that's the arg range written exactly how the original says it — copy it as-is, don't go "fixing" it ✨

📈 rand_exponentional_distribution 📈

(yes, that spelling, keep it, it's the actual method name 💅)

• Title — rand_exponentional_distribution
• Usage — my $var = $dist->rand_exponentional_distribution($param);
• Function — returns a random exponential variate distributed with parameter $param, according to c.d.f 1 - e^(-param * x)
• Returns — floating point number
• Args — $param ( > 0 )

🔔 rand_normal_distribution 🔔

• Title — rand_normal_distribution
• Usage — my $var = $dist->rand_normal_distribution()
• Function — returns a random normal (gaussian) variate distributed
• Returns — floating point number
• Args — none

---

and that's the whole page, bestie, you ate it up 💅 this was the perl documentation, perl v5.32.1, dated 2021-08-15 — go forth and generate some beautifully distributed random numbers, periodt 🌟🦋