diff --git a/lib/node_modules/@stdlib/stats/anova1/lib/main.js b/lib/node_modules/@stdlib/stats/anova1/lib/main.js index 4aba1935490b..fa36f18835b5 100644 --- a/lib/node_modules/@stdlib/stats/anova1/lib/main.js +++ b/lib/node_modules/@stdlib/stats/anova1/lib/main.js @@ -52,6 +52,13 @@ var prettyPrint = require( './print.js' ); * @throws {RangeError} length of `x` must be greater than or equal to two * @throws {RangeError} `x` and `factor` must have the same length * @returns {Object} test results +* +* @example +* var x = [ 1, 3, 5, 2, 4, 6, 8, 7, 10, 11, 12, 15 ]; +* var f = [ 'control', 'treatA', 'treatB', 'treatC', 'control', 'treatA', 'treatB', 'treatC', 'control', 'treatA', 'treatB', 'treatC' ]; +* +* var out = anova1( x, f ); +* // returns {...} */ function anova1( x, factor, options ) { var meanSumSqTreat; // Mean sum of squares diff --git a/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js b/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js index a6f7c30fdd4d..82c9ee0ee02a 100644 --- a/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js +++ b/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js @@ -84,6 +84,17 @@ function upper( x, n, alpha ) { * @throws {TypeError} alternative option has to be a string * @throws {Error} alternative option must be `two-sided`, `less` or `greater` * @returns {Object} test results +* +* @example +* var out = binomialTest( 682, 925 ); +* // returns {...} +* +* @example +* var out = binomialTest( 682, 925, { +* 'p': 0.75, +* 'alpha': 0.05 +* }); +* // returns {...} */ function binomialTest() { var alpha; diff --git a/lib/node_modules/@stdlib/stats/ttest2/lib/main.js b/lib/node_modules/@stdlib/stats/ttest2/lib/main.js index 51fbca7b3c61..ee0be15f5aeb 100644 --- a/lib/node_modules/@stdlib/stats/ttest2/lib/main.js +++ b/lib/node_modules/@stdlib/stats/ttest2/lib/main.js @@ -60,6 +60,13 @@ var print = require( './print.js' ); // eslint-disable-line stdlib/no-redeclare * @throws {TypeError} variance option has to be a string * @throws {Error} variance option must be `equal` or `unequal` * @returns {Object} test result object +* +* @example +* var x = [ 0.7, -1.6, -0.2, -1.2, -0.1, 3.4, 3.7, 0.8, 0.0, 2.0 ]; +* var y = [ 1.9, 0.8, 1.1, 0.1, -0.1, 4.4, 5.5, 1.6, 4.6, 3.4 ]; +* +* var out = ttest2( x, y ); +* // returns {...} */ function ttest2( x, y, options ) { var stderr; diff --git a/lib/node_modules/@stdlib/stats/ztest2/lib/main.js b/lib/node_modules/@stdlib/stats/ztest2/lib/main.js index f22a533d462e..30f99ea6e530 100644 --- a/lib/node_modules/@stdlib/stats/ztest2/lib/main.js +++ b/lib/node_modules/@stdlib/stats/ztest2/lib/main.js @@ -63,6 +63,13 @@ var normCDF = cdfFactory( 0.0, 1.0 ); * @throws {TypeError} must provide valid options * @throws {Error} `alternative` option must be either `two-sided`, `less`, or `greater` * @returns {Object} test result object +* +* @example +* var x = [ 2.66, 1.5, 3.25, 0.993, 2.31, 2.41, 1.76, 2.57, 2.62, 1.23 ]; +* var y = [ 4.88, 2.93, 2.96, 4.5, -0.0603, 4.62, 3.35, 2.98 ]; +* +* var out = ztest2( x, y, 1.0, 2.0 ); +* // returns {...} */ function ztest2( x, y, sigmax, sigmay, options ) { var stderr;