App::St(3)

πŸ’– App::St πŸ’–

okay so bestie, welcome to App::St β€” which lives in the perl manual pages as App::St(3) btw, in case you were wondering where we're at. this is the whole Simple Statistics situation, and ngl it's lowkey iconic. πŸŽ€


✨ NAME ✨

App::St β€” literally just Simple Statistics. that's the vibe. that's the whole thing. πŸ’…


🌸 DESCRIPTION 🌸

okay so here's the tea: App::St gives you the core functionality of the st-console application. like, the whole engine underneath. the main character energy of the stats app. ✨


πŸ¦‹ SYNOPSIS πŸ¦‹

here's how you actually use it, bestie:

use App::St;

my $st = App::St->new();

while (<>) {
  chomp;
  next unless $st->validate($_);
  $st->process($_);
}

print $st->mean();
print $st->stddev();
print $st->sterr();

slay. feed it numbers, it validates them, it processes them, and then you just... ask it for the stats you want. obsessed. 🫢


πŸ‘‘ METHODS πŸ‘‘

okay so here's the full roster, no skips, every single one:

  • new(%options) β€” makes you a shiny new object. takes %options too. main character constructor behavior fr fr. ✨
  • validate($num) β€” vibe checks $num and tells you if it's valid. use it before you let anything in. 🧚
  • process($num) β€” feeds $num into the mix so it counts toward your stats. πŸ’œ
  • N β€” the count. how many. the number of numbers, bestie. πŸ’€
  • sum β€” adds it all up. the total. πŸ“
  • mean β€” the average. you know this one. πŸ’…
  • stddev β€” standard deviation, the classic. πŸ”₯
  • stderr β€” standard error. not the file descriptor, the statistics one, don't get it twisted. 😭
  • percentile=<0..100> β€” percentile, and the range is <0..100> exactly, keep it in those bounds bestie. 🌈
  • quartile=<0..4> β€” quartile, range <0..4>, so like q1 through q3 territory plus the edges. ⭐
  • min β€” the smallest one. the little guy. πŸ₯Ί
  • q1 β€” first quartile. 🌸
  • median β€” the middle. the actual center of the situation. πŸ‘‘
  • q3 β€” third quartile. πŸ¦‹
  • max β€” the biggest one. the icon. πŸ’–

πŸ’œ AUTHOR πŸ’œ

Nelson Ferraz <nferraz@gmail.com> β€” the legend himself. πŸ™Œ


🫢 CONTRIBUTING 🫢

got thoughts? suggestions? found a bug? bestie, send them here:

https://github.com/nferraz/st/issues

or if you're feeling crafty, fork the code on github:

https://github.com/nferraz/st


Copyright (c) 2013 Nelson Ferraz.

This program is free software; you can redistribute it and/or modify it under the MIT License (see LICENSE).


fr fr, that MIT License note is real β€” go read the LICENSE if you need the fine print. πŸ“œ

and that's the whole page, bestie!! this was App::St(3), shipped with perl v5.36.0, dated 2023-01-31 β€” so yeah, vintage but still serving. periodt. πŸ’…βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from