API reference¶

The API generated with phpDocumentor is available in the menu under API. Use this page as a quick map of classes and minimal examples.

Info

If you run the site locally, open the API section to browse namespaces, classes, and methods.

Class map¶

ClassicStats: classic statistics (mean, deviation, variance, outliers).
RobustStats: robust statistics (Huber, MAD, IQR, robust CV).
QuantileEngine: R-compatible quantiles types 1-9.
CentralTendencyEngine: median, Huber, and robust means.
StatsComparator: bias verdict between classic and robust.

Minimal examples¶

ClassicStats¶

use Cjuol\StatGuard\ClassicStats;

$classic = new ClassicStats();
$data = [1, 2, 3, 4, 5];

$mean = $classic->getMean($data);
$summary = $classic->getSummary($data);

RobustStats¶

use Cjuol\StatGuard\RobustStats;

$robust = new RobustStats();
$data = [1, 2, 3, 4, 5, 1000];

$huber = $robust->getHuberMean($data);
$iqr = $robust->getIqr($data, RobustStats::TYPE_R_DEFAULT);

QuantileEngine¶

use Cjuol\StatGuard\QuantileEngine;

$engine = new QuantileEngine();
$data = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];

$q7 = $engine->quantile($data, 0.75, 7);

StatsComparator¶

use Cjuol\StatGuard\StatsComparator;

$comparator = new StatsComparator();
$data = [10, 12, 11, 15, 10, 1000];

$analysis = $comparator->analyze($data);
echo $analysis['verdict'];