Skip to content
This repository

JavaScript Statistical Library

branch: master

Changed documentation to clarify Correlation

Fix issue #73, 'What types of correlation does jstat do?'

Clarify Documentation:
- Which standard deviation estimator is calculated by stdev()
- Which variance estimator is calculated by variance()
- Which correlation coefficient is calculated by corrcoeff() (Pearson's
  Rho)

Signed-off-by: Trevor Norris <trev.norris@gmail.com>
latest commit 25f980e3e0
jamescgibson jamescgibson authored April 22, 2014 trevnorris committed April 23, 2014
Octocat-spinner-32 build add npm dependencies. simplify Makefile. remove jshint checks. remove… March 06, 2012
Octocat-spinner-32 doc Changed documentation to clarify Correlation April 23, 2014
Octocat-spinner-32 src Changed documentation to clarify Correlation April 23, 2014
Octocat-spinner-32 test Remove so many spaces April 28, 2013
Octocat-spinner-32 .gitignore add npm dependencies. simplify Makefile. remove jshint checks. remove… March 06, 2012
Octocat-spinner-32 AUTHORS Update AUTHORS September 10, 2012
Octocat-spinner-32 MIT-LICENSE.txt Update copyright info April 28, 2013
Octocat-spinner-32 Makefile Fix 'make doc' issue on systems with node & nodejs April 01, 2014
Octocat-spinner-32 README.md Correct typo in Readme/Running Tests March 19, 2014
Octocat-spinner-32 package.json Add couple cli options to vows/npm test November 18, 2013
README.md

jStat - JavaScript Statistical Library

Build Prerequisites

In order to build jStat, you need to have GNU make 3.8 or later, Node.js 0.2 or later, and git 1.7 or later. (Earlier versions might work OK, but are not tested.)

Windows users have two options:

  1. Install msysgit (Full installer for official Git), GNU make for Windows, and a binary version of Node.js. Make sure all three packages are installed to the same location (by default, this is C:\Program Files\Git).
  2. Install Cygwin (make sure you install the git, make, and which packages), then either follow the Node.js build instructions or install the binary version of Node.js.

Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from Apple's Xcode site) and http://mxcl.github.com/homebrew/. Once Homebrew is installed, run brew install git to install git, and brew install node to install Node.js.

Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source if you swing that way.

Building jStat

First, clone a copy of the jStat git repo by running git clone git://github.com/jstat/jstat.git.

To download all necessary libraries run npm install.

Then, to get a complete, minified version of jStat and all documentation, simply cd to the jstat directory and type make. If you don't have Node installed and/or want to make a basic, uncompressed, unlinted version of jstat, use make jstat instead of make.

The built version of jStat will be put in the dist/ subdirectory.

Generate just the documentation by running make doc. Documentation will be placed in dist/docs by default.

To remove all built files, run make clean.

Running Tests

Execute all tests by running make test.

Or if you wish to run a specific test, cd to test/<subdir> and run node <some_test>-test.js.

Join the Community

We always like discussion of how to improve jStat. Join us at our mailing list and let us know what you'd like to see. Also come ask questions in the #jstat channel on irc.freenode.net.

Something went wrong with that request. Please try again.