I just released statistex – a library to calculate statistics based on a given data sample. It’s an extraction from my benchmarking library benchee and part of what I’ll henceforth call the “benchee library family”. As it’s been running in benchee basically since its inception I dubbed it 1.0.
The extraction is good because it helps the benchee code base focus on benchmarking and not things around it. It removes about 800 lines from the repo and it makes that code reusable for everyone else. It also makes it easier to introduce new statistics as it’s clearer that we’ll first introduce the logic inside statistex and later on just display it in benchee and friends. It’s good design.
Do we really need another statistics library?
I struggled with this question. I don’t want to split the eco system unnecessarily. To be honest, I thought there was no other library out there. There are at least statistics and Numerix, though. Not sure how I missed them when I started incorporating more advanced statistics.
Both include more functions than just for statistics: general math and more (drawing of random values for instance). They also support more statistical values than statistex at the time of this writing. So if you’re looking for something, that statistex doesn’t provide (yet) these are some of the first places I’d look.
Why would you still want to use statistex? Well there are some things it offers that the others don’t (to the best of my knowledge):
statistics/2 – Give me everything!
As mentioned before, statistex was extracted and the way it was used in benchee is just “give me all the statistics so that formatters can display them!” – so there’s a function that does exactly this:
What’s cool about this? Well, little effort, big result! This is quite nice to explore data sets in iex for instance. Behind the scenes statistex reuses previously calculated values so that no value is calculated twice. For instance first you get the
sampe_size and the
total, both are then used to calculate the
sample_size are then passed on to calculate the
variance and so forth. This way statistex is fast by not duplicating work if you want a bunch of statistical values (and benchee wants most of them).
But you don’t want all of these values but would still like to reuse previously calculated values? Got you covered!
Manually reuse previously calculated values
Say you want to calculate the variance but have already calculated the average and sample_size. Easy:
variance/2 a lot of function take an optional keyword list as arguments where you can provide previously calculated values (options are of course documented).
Raising on empty list input
Thanks to a discussion on elixir forum I made the decision to raise an
ArgumentError when statistex is handed an empty list in most functions. Why? The statistics don’t make any sense at this point and it’s likely some kind of error either way/you probably want to display something other than a bunch of
I know many won’t consider this a feature, I quite like the direction it pushes client code towards, though.
Is this enough for a new library?
I think so. 🙂 Especially getting all values at once and reusing previously calculated values are incredibly valuable properties. I also like that statistex is solely focussed on statistics. And the statistics it can’t compute yet? We’ll catch up on that over time. Moreover, it’s not like I spent some huge amount of work writing it as it was a simple extraction.
I’d be happy if you gave statistex a trial run and left some feedback.