Skip to content

Commit

Permalink
Fix API docs, fixes #72. Experiment with coveralls
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Jun 14, 2014
1 parent e19b701 commit f498a5e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
language: node_js
node_js:
- 0.10
script:
- npm install
- npm test
- npm run cov
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ as one-dimensional arrays of more than one number each.
Produces [sample variance](http://mathworld.wolfram.com/SampleVariance.html)
of a single-dimensional array of numbers.

### .sample_covariance(x)
### .sample_covariance(a, b)

Produces [sample covariance](http://en.wikipedia.org/wiki/Sample_mean_and_sample_covariance)
of two single-dimensional arrays of numbers.

### .sample_correlation(x)
### .sample_correlation(a, b)

Produces [sample correlation](http://en.wikipedia.org/wiki/Correlation_and_dependence)
of two single-dimensional arrays of numbers.
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ Mean of a single-dimensional Array of numbers. _Also available as `.average(x)`_

Sum of a single-dimensional Array of numbers.

### .mode(x)

Returns the number that appears most frequently in a single-dimensional Array
of numbers. If there are multiple modes, the one that appears last
is returned.

### .variance(x)

[Variance](http://en.wikipedia.org/wiki/Variance) of a single-dimensional Array of numbers.
Expand Down Expand Up @@ -88,12 +94,12 @@ as one-dimensional arrays of more than one number each.
Produces [sample variance](http://mathworld.wolfram.com/SampleVariance.html)
of a single-dimensional array of numbers.

### .sample_covariance(x)
### .sample_covariance(a, b)

Produces [sample covariance](http://en.wikipedia.org/wiki/Sample_mean_and_sample_covariance)
of two single-dimensional arrays of numbers.

### .sample_correlation(x)
### .sample_correlation(a, b)

Produces [sample correlation](http://en.wikipedia.org/wiki/Correlation_and_dependence)
of two single-dimensional arrays of numbers.
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@
"devDependencies": {
"mocha": "1.17.x",
"chai": "1.9.x",
"jshint": "2.4.4"
"jshint": "2.4.4",
"mocha-lcov-reporter": "0.0.1",
"coveralls": "~2.10.0"
},
"scripts": {
"test": "jshint src/*.js && mocha -R spec test/spec",
"cov": "istanbul cover node_modules/.bin/_mocha --report lcovonly test/spec && coveralls < ./coverage/lcov.info",
"api": "node api.js"
},
"main": "src/simple_statistics.js",
Expand Down

0 comments on commit f498a5e

Please sign in to comment.