Table of contents1. Installation 2. Getting Started 3. Building jStat 4. Running Tests 5. Get the Code 6. Contributing 7. Licensing
InstallationUse npm to download the project.
npm install @handsontable/jstat
Getting StartedjStat can be used in the browser. The
jStatobject will be added to the window. For example:
<script src="https://cdn.jsdelivr.net/npm/@handsontable/jstat/dist/jstat.min.js"></script> <!-- include jStat, from the CDN or otherwise --> <script> var jstat = this.jStat(dataset); // jStat will be added to the window data[i]['cum'] = jstat.normal(jstat.mean(), jstat.stdev()).cdf(data[i].x); </script>
Using jStat in Node environment.
const jStat = require('@handsontable/jstat'); data[i]['cum'] = jStat.normal(jStat.mean(), jStat.stdev()).cdf(data[i].x);
Building jStatFirst, clone a copy of the jStat git repo by running
git clone https://github.com/handsontable/jstat.git.
To download all necessary dependencies run
npm installin the cloned repository.
Then, to get a complete, minified version of jStat and all documentation, simply type
npm run all.
The built version of jStat will be put in the
Generate just the documentation by running
npm run doc. Documentation will be placed in
To remove all built files, run
npm run clean.
Running TestsExecute all tests by running
npm run test.
Or if you wish to run a specific test,
Get the CodeBoth the minified and unminified source are located in the
dist/directory. For those who don't want to build it themselves.