statestes

Statistics for n00bs. Tastefully done. You're welcome.

A simple Javascript library for statistical analysis

Installing / Getting started

Install using npm:

npm install statestes

Import in code

var statestes = require('statestes').statestes;

Install using yarn:

yarn add statestes

Import in code

var statestes = require('statestes').statestes;

Install using the built library.

Copy statestes.min.js from dist/statestes.min.js to a lib folder.

Import in code

<script src="lib/statestes.min.js"></script>

This will expose a statestes variable which you can access the functions from.

Include using CDN

<script src="https://cdn.jsdelivr.net/npm/statestes/dist/statestes.min.js"></script>

The script can also be included from a CDN for faster and likely cached delivery, it can that be used through the statestes variable as described below.

Using a function in the library:

Just reference a function using the dot notation. For example, to use the sum function, you can do:

  statestes.sum([1, 2, 3]); // 6

Developing

Built With

This project has no dependencies.

Prerequisites

The dev prerequisites for this project are:

• Babel - for transpiling ES6 to ES5 code.
• Fusebox - a faster and simpler module bundler.
• Jest - Facebook's testing framework.

Setting up Dev

To start developing, run:

git clone https://github.com/johnpaulada/statestes.git
cd your-project/
yarn

This will:

1. Clone the project
2. Get you into the project
3. Install the dev dependencies

Building

To build the project, run:

npm start

This command will build the code to dist/statestes.min.js. Each change to the code will rebuild the code.

Tests

I use Jest to test this library. To run the tests, run:

npm test

These tests test the main statistical functions.

Licensing

MIT