Skip to content

Commit 944ddb4

Browse files
PlaneshifterPlaneshifter
committed
Rename binomial test package
1 parent 10d9ebd commit 944ddb4

File tree

18 files changed

+58
-58
lines changed

18 files changed

+58
-58
lines changed

‎lib/node_modules/@stdlib/namespace/lib/namespace/b.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6925,9 +6925,9 @@ ns.push({
69256925
});
69266926

69276927
ns.push({
6928-
'alias': 'binomTest',
6929-
'path': '@stdlib/stats/binom-test',
6930-
'value': require( '@stdlib/stats/binom-test' ),
6928+
'alias': 'binomialTest',
6929+
'path': '@stdlib/stats/binomial-test',
6930+
'value': require( '@stdlib/stats/binomial-test' ),
69316931
'type': 'Function',
69326932
'related': []
69336933
});

lib/node_modules/@stdlib/stats/binom-test/README.md renamed to lib/node_modules/@stdlib/stats/binomial-test/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var binomTest = require( '@stdlib/stats/binom-test' );
30+
var binomialTest = require( '@stdlib/stats/binomial-test' );
3131
```
3232

33-
#### binomTest( x\[, n]\[, opts] )
33+
#### binomialTest( x\[, n]\[, opts] )
3434

3535
When supplied non-negative integers `x` (number of successes in a Bernoulli experiment) and `n` (total number of trials), the function computes an exact test for the success probability in a Bernoulli experiment. Alternatively, `x` may be a two-element array containing the number of successes and failures, respectively.
3636

3737
```javascript
38-
var out = binomTest( 550, 1000 );
38+
var out = binomialTest( 550, 1000 );
3939
/* returns
4040
{
4141
'rejected': true,
@@ -46,7 +46,7 @@ var out = binomTest( 550, 1000 );
4646
}
4747
*/
4848

49-
out = binomTest( [ 550, 450 ] );
49+
out = binomialTest( [ 550, 450 ] );
5050
/* returns
5151
{
5252
'rejected': true,
@@ -86,7 +86,7 @@ The function accepts the following `options`:
8686
By default, the hypothesis test is carried out at a significance level of `0.05`. To choose a different significance level, set the `alpha` option.
8787

8888
```javascript
89-
var out = binomTest( 59, 100, {
89+
var out = binomialTest( 59, 100, {
9090
'alpha': 0.1
9191
});
9292
/* returns
@@ -103,7 +103,7 @@ var out = binomTest( 59, 100, {
103103
By default, a two-sided test is performed. To perform either of the one-sided tests, set the `alternative` option to `less` or `greater`.
104104

105105
```javascript
106-
out = binomTest( 550, 1000, {
106+
out = binomialTest( 550, 1000, {
107107
'alternative': 'greater'
108108
});
109109
table = out.print();
@@ -119,7 +119,7 @@ table = out.print();
119119
Test Decision: Reject null in favor of alternative at 5% significance level
120120
*/
121121

122-
out = binomTest( 550, 1000, {
122+
out = binomialTest( 550, 1000, {
123123
'alternative': 'less'
124124
});
125125
table = out.print();
@@ -139,7 +139,7 @@ table = out.print();
139139
To test whether the success probability in the population is equal to some other value than `0.5`, set the `p` option.
140140

141141
```javascript
142-
var out = binomTest( 23, 100, {
142+
var out = binomialTest( 23, 100, {
143143
'p': 0.2
144144
});
145145
/* returns
@@ -177,9 +177,9 @@ var table = out.print();
177177
<!-- eslint no-undef: "error" -->
178178

179179
```javascript
180-
var binomTest = require( '@stdlib/stats/binom-test' );
180+
var binomialTest = require( '@stdlib/stats/binomial-test' );
181181

182-
var out = binomTest( 682, 925 );
182+
var out = binomialTest( 682, 925 );
183183
/* returns
184184
{
185185
'rejected': true,
@@ -190,7 +190,7 @@ var out = binomTest( 682, 925 );
190190
}
191191
*/
192192

193-
out = binomTest( [ 682, 925 - 682 ] );
193+
out = binomialTest( [ 682, 925 - 682 ] );
194194
/* returns
195195
{
196196
'rejected': true,
@@ -201,7 +201,7 @@ out = binomTest( [ 682, 925 - 682 ] );
201201
}
202202
*/
203203

204-
out = binomTest( 682, 925, {
204+
out = binomialTest( 682, 925, {
205205
'p': 0.75,
206206
'alpha': 0.05
207207
});
@@ -215,7 +215,7 @@ out = binomTest( 682, 925, {
215215
}
216216
*/
217217

218-
out = binomTest( 21, 40, {
218+
out = binomialTest( 21, 40, {
219219
'p': 0.4,
220220
'alternative': 'greater'
221221
});

lib/node_modules/@stdlib/stats/binom-test/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/stats/binomial-test/benchmark/benchmark.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var isObject = require( '@stdlib/assert/is-object' );
2525
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
2626
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
2727
var pkg = require( './../package.json' ).name;
28-
var binomTest = require( './../lib' );
28+
var binomialTest = require( './../lib' );
2929

3030

3131
// MAIN //
@@ -40,7 +40,7 @@ bench( pkg, function benchmark( b ) {
4040
for ( i = 0; i < b.iterations; i++ ) {
4141
x = discreteUniform( 0, 1000 );
4242
n = x + discreteUniform( 0, 1000 );
43-
result = binomTest( x, n );
43+
result = binomialTest( x, n );
4444
if ( typeof result !== 'object' ) {
4545
b.fail( 'should return an object' );
4646
}
@@ -63,7 +63,7 @@ bench( pkg+'::array', function benchmark( b ) {
6363
for ( i = 0; i < b.iterations; i++ ) {
6464
arr[ 0 ] = discreteUniform( 0, 1000 );
6565
arr[ 1 ] = discreteUniform( 0, 1000 );
66-
result = binomTest( arr );
66+
result = binomialTest( arr );
6767
if ( typeof result !== 'object' ) {
6868
b.fail( 'should return an object' );
6969
}
@@ -91,7 +91,7 @@ bench( pkg+'::one-sided', function benchmark( b ) {
9191
for ( i = 0; i < b.iterations; i++ ) {
9292
x = discreteUniform( 0, 1000 );
9393
n = x + discreteUniform( 0, 1000 );
94-
result = binomTest( x, n, opts );
94+
result = binomialTest( x, n, opts );
9595
if ( typeof result !== 'object' ) {
9696
b.fail( 'should return an object' );
9797
}
@@ -119,7 +119,7 @@ bench( pkg+'::p=0.8', function benchmark( b ) {
119119
for ( i = 0; i < b.iterations; i++ ) {
120120
x = discreteUniform( 0, 1000 );
121121
n = x + discreteUniform( 0, 1000 );
122-
result = binomTest( x, n, opts );
122+
result = binomialTest( x, n, opts );
123123
if ( typeof result !== 'object' ) {
124124
b.fail( 'should return an object' );
125125
}
@@ -138,7 +138,7 @@ bench( pkg+':print', function benchmark( b ) {
138138
var output;
139139
var i;
140140

141-
result = binomTest( 682, 925 );
141+
result = binomialTest( 682, 925 );
142142

143143
b.tic();
144144
for ( i = 0; i < b.iterations; i++ ) {

lib/node_modules/@stdlib/stats/binom-test/docs/repl.txt renamed to lib/node_modules/@stdlib/stats/binomial-test/docs/repl.txt

File renamed without changes.

lib/node_modules/@stdlib/stats/binom-test/examples/index.js renamed to lib/node_modules/@stdlib/stats/binomial-test/examples/index.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@
1818

1919
'use strict';
2020

21-
var binomTest = require( './../lib' );
21+
var binomialTest = require( './../lib' );
2222

23-
var out = binomTest( 682, 925 );
23+
var out = binomialTest( 682, 925 );
2424
console.log( out );
2525

26-
out = binomTest( [ 682, 925 - 682 ] );
26+
out = binomialTest( [ 682, 925 - 682 ] );
2727
console.log( out );
2828

29-
out = binomTest( 682, 925, {
29+
out = binomialTest( 682, 925, {
3030
'p': 0.75,
3131
'alpha': 0.05
3232
});
3333
console.log( out );
3434

35-
out = binomTest( 21, 40, {
35+
out = binomialTest( 21, 40, {
3636
'p': 0.4,
3737
'alternative': 'greater'
3838
});

lib/node_modules/@stdlib/stats/binom-test/lib/index.js renamed to lib/node_modules/@stdlib/stats/binomial-test/lib/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
/**
2222
* Compute an exact test for the success probability in a Bernoulli experiment.
2323
*
24-
* @module @stdlib/stats/binom-test
24+
* @module @stdlib/stats/binomial-test
2525
*
2626
* @example
27-
* var binomTest = require( '@stdlib/stats/binom-test' );
27+
* var binomialTest = require( '@stdlib/stats/binomial-test' );
2828
*
29-
* var out = binomTest( 682, 925 );
29+
* var out = binomialTest( 682, 925 );
3030
* // returns {...}
3131
*
32-
* out = binomTest( 682, 925, {
32+
* out = binomialTest( 682, 925, {
3333
* 'p': 0.75,
3434
* 'alpha': 0.05
3535
* });
@@ -38,9 +38,9 @@
3838

3939
// MODULES //
4040

41-
var binomTest = require( './main.js' );
41+
var binomialTest = require( './main.js' );
4242

4343

4444
// EXPORTS //
4545

46-
module.exports = binomTest;
46+
module.exports = binomialTest;

lib/node_modules/@stdlib/stats/binom-test/lib/main.js renamed to lib/node_modules/@stdlib/stats/binomial-test/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ function upper( x, n, alpha ) {
8484
* @throws {Error} alternative option must be `two-sided`, `less` or `greater`
8585
* @returns {Object} test results
8686
*/
87-
function binomTest() {
87+
function binomialTest() {
8888
var alpha;
8989
var opts;
9090
var cint;
@@ -204,4 +204,4 @@ function binomTest() {
204204

205205
// EXPORTS //
206206

207-
module.exports = binomTest;
207+
module.exports = binomialTest;

lib/node_modules/@stdlib/stats/binom-test/lib/print.js renamed to lib/node_modules/@stdlib/stats/binomial-test/lib/print.js

File renamed without changes.

lib/node_modules/@stdlib/stats/binom-test/lib/validate.js renamed to lib/node_modules/@stdlib/stats/binomial-test/lib/validate.js

File renamed without changes.

lib/node_modules/@stdlib/stats/binom-test/package.json renamed to lib/node_modules/@stdlib/stats/binomial-test/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/stats/binom-test",
2+
"name": "@stdlib/stats/binomial-test",
33
"version": "0.0.0",
44
"description": "Exact test for the success probability in a Bernoulli experiment.",
55
"license": "Apache-2.0",

0 commit comments

Comments
 (0)