Nuclear Pumpkin Mayhem

    compute-nanmin

    1.0.0 • Public • Published

    nanmin

    NPM version Build Status Coverage Status Dependencies

    Computes the minimum value of an array ignoring non-numeric values.

    Installation

    $ npm install compute-nanmin

    For use in the browser, use browserify.

    Usage

    To use the module,

    var min = require( 'compute-nanmin' );

    min( arr )

    Computes the minimum value of an array ignoring non-numeric values.

    var data = [ 2, null, 5, 3, null, 7 ];
     
    var val = min( data );
    // returns 2

    Note: if an input array does not contain any numeric values, the function returns null.

    Examples

    var min = require( 'compute-nanmin' );
     
    // 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 ] = Math.round( Math.random()*100 );
        }
    }
    var val = min( 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

    MIT license.


    Copyright

    Copyright © 2014. Athan Reines.

    Install

    npm i compute-nanmin

    DownloadsWeekly Downloads

    260

    Version

    1.0.0

    License

    none

    Last publish

    Collaborators

    • kgryte