time-to-botec/js/node_modules/@stdlib/stats/binomial-test/lib/index.js

47 lines
1.1 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Compute an exact test for the success probability in a Bernoulli experiment.
*
* @module @stdlib/stats/binomial-test
*
* @example
* var binomialTest = require( '@stdlib/stats/binomial-test' );
*
* var out = binomialTest( 682, 925 );
* // returns {...}
*
* out = binomialTest( 682, 925, {
* 'p': 0.75,
* 'alpha': 0.05
* });
* // returns {...}
*/
// MODULES //
var binomialTest = require( './main.js' );
// EXPORTS //
module.exports = binomialTest;