To help you get started, we've collected the most common ways that simple-statistics is being used within popular public projects.

antvis / data-set / test / unit / api / statistics-spec.ts View on Github

it('statistics methods on fields of array', () => {
    const data = [];
    for (let i = 1; i <= 10; i++) {
      // 1~10
      data.push({
        a: [i, i + 10, [-i, i * i, [-i * i, 1 / i]]],
      });
    }
    const dv = new DataSet.View().source(data);
    const values = flattenDeep(dv.getColumn('a'));
    expect(dv.max('a')).to.equal(max(values));
    expect(dv.min('a')).to.equal(min(values));
    expect(dv.mean('a')).to.equal(mean(values));
    expect(dv.average('a')).to.equal(mean(values));
    expect(dv.median('a')).to.equal(median(values));
    expect(dv.mode('a')).to.equal(mode(values));
    expect(dv.quantile('a', 0.5)).to.equal(quantile(values, 0.5));
    expect(dv.quantiles('a', [0, 0.1, 0.5])).to.eql(map([0, 0.1, 0.5], (p) => quantile(values, p)));
    expect(dv.quantilesByFraction('a', 4)).to.eql(map([0, 0.25, 0.5, 0.75, 1], (p) => quantile(values, p)));
    expect(dv.standardDeviation('a')).to.equal(standardDeviation(values));
    expect(dv.sum('a')).to.equal(sum(values));
    expect(dv.variance('a')).to.equal(variance(values));
    expect(dv.range('a')).to.eql([min(values), max(values)]);
  });
});

View more ways to use simple-statistics

Simple Statistics

A JavaScript implementation of descriptive, regression, and inference statistics.

Implemented in literate JavaScript with no dependencies, designed to work in all modern browsers (including IE) as well as in node.js.

• 📗 API Documentation
• 📈 Benchmarks
• 😗 A list of other statistics libraries

Installation

• I'm using Node.js, Webpack, Browserify, Rollup, or another module bundler, and install packages from npm.
  • First, install the simple-statistics module, using npm install simple-statistics, then include the code with require or import:
  • I use the require function to use modules in my project. (most likely)
    • When you use require, you have the freedom to assign the module to any variable name you want, but you need to specify the module's name exactly: in this case, 'simple-statistics'. The require method returns an object with all of the module's methods attached to it.
      

      var ss = require('simple-statistics')

  • I use import to use modules in my project. I'm probably using Babel, @std/esm, Webpack, or Rollup.
    • Import all functions under the ss object:

      import * as ss from 'simple-statistics'

      Include a specific named export:

      import {min} from 'simple-statistics'

      Simple statistics has only named exports for ES6.
• I'm using Deno.
  • Simple Statistics is published for Deno: https://deno.land/x/simplestatistics
• I'm not using a module bundler. I'm writing a web page, and want to include simple-statistics using a script tag.
  • I want to support all browsers
    • When you use simple-statistics from a script tag, you don't get to choose the variable name it is assigned to: simple-statistics will always become available globally as the variable ss. You can reassign this variable to another name if you want to, but doing so is optional.

  • I want to use ES6 modules in a browser and I'm willing to only support new browsers to do it
    • This module works great with the ?module query parameter of unpkg. If you specify type='module' in your script tag, you'll be able to import simple-statistics directly - through index.js and with true ES6 import syntax and behavior.
      This feature is still experimental in unpkg and very bleeding-edge.