1.6.0 • Published 3 years ago
percentile v1.6.0
percentile
Calculate a percentile for given array of values.
Install
npm install percentile
Usage
// With simple values
const percentile = require("percentile");
console.log(percentile(80, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])); // 8
// With complex values
const percentile = require("percentile");
const result = percentile(
80,
[
{ val: 1 }, { val: 2 }, { val: 3 }, { val: 4 }, { val: 5 },
{ val: 6 }, { val: 7 }, { val: 8 }, { val: 9 }, { val: 10 }
],
// function to extract a value from an object
item => item.val
);
console.log(result); // 8
// With array of percentiles
const percentile = require("percentile");
const result = percentile(
[70, 80, 90], // calculates 70p, 80p and 90p in one pass
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
);
console.log(result); // [7, 8, 9]
Notes
Non-numeric (NaN) values are treated as the smallest values, Eg percentile(50, [ 5, 2, NaN]) === 2
Author
Stanislav Sysoev d4rkr00t@gmail.com https://github.com/d4rkr00t
License
Contributing
Contributing are highly welcome! This repos is commitizen friendly — please read about it here.