compute-mstdev/README.md

Computes a moving sample standard deviation over a numeric array.

Moving Sample Standard Deviation
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Computes a moving (sliding window) sample standard deviation over a numeric array.


## Installation

``` bash
$ npm install compute-mstdev
```

For use in the browser, use [browserify](https://github.com/substack/node-browserify).


## Usage

To use the module,

``` javascript
var mstdev = require( 'compute-mstdev' );
```

#### mstdev( arr, window )

Slides a `window` over a numeric `array` to compute a moving sample standard deviation.

``` javascript
var data = [ 1, 5, 0, 10, 2 ];

var arr = mstdev( data, 3 );
// returns [ ~2.6, 5, ~5.3 ]
```

Note: the returned `array` has length `L - W + 1`, where `L` is the length of the input `array` and `W` is the `window` size. 


## Examples

``` javascript
var mstdev = require( 'compute-mstdev' );

// Simulate some data...
var data = new Array( 50 );

for ( var i = 0; i < data.length; i++ ) {
	data[ i ] = Math.random() * 100;
}

// Compute the moving sample standard deviation:
var arr = mstdev( data, 7 );

console.log( arr.join( '\n' ) );
```

To run the example code from the top-level application directory,

``` bash
$ node ./examples/index.js
```


## Tests

### Unit

Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

All new feature development should have corresponding unit tests to validate correct functionality.


### Test Coverage

This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,

``` bash
$ make view-cov
```


## License

[MIT license](http://opensource.org/licenses/MIT). 


---
## Copyright

Copyright &copy; 2014. Athan Reines.


[npm-image]: http://img.shields.io/npm/v/compute-mstdev.svg
[npm-url]: https://npmjs.org/package/compute-mstdev

[travis-image]: http://img.shields.io/travis/compute-io/mstdev/master.svg
[travis-url]: https://travis-ci.org/compute-io/mstdev

[coveralls-image]: https://img.shields.io/coveralls/compute-io/mstdev/master.svg
[coveralls-url]: https://coveralls.io/r/compute-io/mstdev?branch=master

[dependencies-image]: http://img.shields.io/david/compute-io/mstdev.svg
[dependencies-url]: https://david-dm.org/compute-io/mstdev

[dev-dependencies-image]: http://img.shields.io/david/dev/compute-io/mstdev.svg
[dev-dependencies-url]: https://david-dm.org/dev/compute-io/mstdev

[github-issues-image]: http://img.shields.io/github/issues/compute-io/mstdev.svg
[github-issues-url]: https://github.com/compute-io/mstdev/issues