compute-nanmax
v1.0.0
Published
Computes the maximum value of an array ignoring non-numeric values.
Downloads
1,103
Maintainers
Readme
nanmax
Computes the maximum value of an array ignoring non-numeric values.
Installation
$ npm install compute-nanmax
For use in the browser, use browserify.
Usage
To use the module,
var max = require( 'compute-nanmax' );
max( arr )
Computes the maximum value of an array ignoring non-numeric values.
var data = [ -5, null, -2, -3, null, -7 ];
var val = max( data );
// returns -2
Note: if an input array
does not contain any numeric values, the function returns null
.
Examples
var max = require( 'compute-nanmax' );
// Simulate some data...
var data = new Array( 100 );
for ( var i = 0; i < data.length; i++ ) {
// Every so often insert a missing value...
if ( i%10 ) {
data[ i ] = null;
} else {
data[ i ] = -1 * Math.round( Math.random()*100 );
}
}
var val = max( data );
console.log( val );
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2014. Athan Reines.