File tree Expand file tree Collapse file tree 2 files changed +7
-4
lines changed
lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64 Expand file tree Collapse file tree 2 files changed +7
-4
lines changed Original file line number Diff line number Diff line change @@ -51,7 +51,7 @@ var results = new Float64Results();
51
51
52
52
The function supports the following parameters:
53
53
54
- - ** arg** : an ` ArrayBuffer ` or a data object (_ optional_ ).
54
+ - ** arg** : an [ ` ArrayBuffer ` ] [ @stdlib/array/buffer ] or a data object (_ optional_ ).
55
55
- ** byteOffset** : byte offset (_ optional_ ).
56
56
- ** byteLength** : maximum byte length (_ optional_ ).
57
57
@@ -62,7 +62,7 @@ A data object argument is an object having one or more of the following properti
62
62
- ** alpha** : significance level.
63
63
- ** pValue** : p-value.
64
64
- ** statistic** : test statistic.
65
- - ** ci** : confidence interval as a ` Float64Array ` .
65
+ - ** ci** : confidence interval as a [ ` Float64Array ` ] [ @stdlib/array/float64 ] .
66
66
- ** nullValue** : mean under the null hypothesis.
67
67
- ** sd** : standard error of the mean.
68
68
@@ -316,6 +316,10 @@ console.log( str );
316
316
317
317
[ @stdlib/array/dataview ] : https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dataview
318
318
319
+ [ @stdlib/array/float64 ] : https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
320
+
321
+ [ @stdlib/array/buffer ] : https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/buffer
322
+
319
323
</section >
320
324
321
325
<!-- /.links -->
Original file line number Diff line number Diff line change 24
24
* @module @stdlib /stats/base/ztest/one-sample/results/float64
25
25
*
26
26
* @example
27
- * var resolveEnum = require( '@stdlib/stats/base/ztest/alternative-resolve-enum' );
28
27
* var Float64Array = require( '@stdlib/array/float64' );
29
28
* var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
30
29
*
31
30
* var results = new Results();
32
31
* // returns <Results>
33
32
*
34
- * results.alternative = resolveEnum( 'two-sided' ) ;
33
+ * results.alternative = 'two-sided';
35
34
* results.alpha = 0.05;
36
35
* results.nullValue = 0.0;
37
36
* results.pValue = 0.3374;
You can’t perform that action at this time.
0 commit comments