README.md

phpquartiles

PHP package for working out quartile values and placements based on a numeric array.

phpquartiles will return the 1st, 2nd and 3rd quartiles. You can also then find the quartile placement of a given score.

Install

Via Composer

$ composer require PierceMcGeough/phpquartiles

Usage

$scoresArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
$quartiles = new PierceMcGeough\phpquartiles\Quartile();

Quartile Commands

$quartiles->getAllQuartiles();
/**
 *  returns
 *
 *  [
 *      [q1] => 4
 *      [q2] => 8
 *      [q3] => 12
 *  ]
 */


$quartiles->getFirstQuartile();
/**
 *  returns
 *
 *  4
 */


$quartiles->getMedianQuartile();
/**
 *  returns
 *
 *  8
 */


$quartiles->getSecondQuartile();
/**
 *  alias of getMedianQuartile()
 *  returns
 *
 *  8
 */


$quartiles->getThirdQuartile();
/**
 *  returns
 *
 *  12
 */

Placement Commands

$quartiles->getPlacement(15);
/**
 *  returns
 *
 *  HIGHEST_QUARTILE
 */


$quartiles->getPlacementInverse(15);
/**
 *  returns
 *
 *  LOWEST_QUARTILE
 */

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Pierce McGeough
• All Contributors

License

The MIT License (MIT). Please see License File for more information.