Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2020 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';
// MODULES //
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
var isObject = require( '@stdlib/assert/is-plain-object' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var roundn = require( '@stdlib/math/base/special/roundn' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Pretty-print output of test.
*
* @param {Object} [opts] - options object
* @param {PositiveInteger} [opts.digits=4] - number of digits after the decimal point
* @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {string} formatted output
*/
function print( opts ) { // eslint-disable-line stdlib/no-redeclare
/* eslint-disable no-invalid-this */
var decision;
var dgts;
var str;
dgts = 4;
decision = true;
if ( arguments.length > 0 ) {
if ( !isObject( opts ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an object. Value: `%s`.', opts ) );
}
if ( hasOwnProp( opts, 'digits' ) ) {
if ( !isPositiveInteger( opts.digits ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'digits', opts.digits ) );
}
dgts = opts.digits;
}
if ( hasOwnProp( opts, 'decision' ) ) {
if ( !isBoolean( opts.decision ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'decision', opts.decision ) );
}
decision = opts.decision;
}
}
str = '';
str += this.method;
str += '\n\n';
str += 'Alternative hypothesis: ';
if ( this.method === 'Paired Wilcoxon signed rank test' ) {
str += 'Median of the difference `x - y` is ';
} else {
str += 'Median of `x` is ';
}
switch ( this.alternative ) {
case 'less':
str += 'less than ';
break;
case 'greater':
str += 'greater than ';
break;
case 'two-sided':
default:
str += 'not equal to ';
break;
}
str += this.nullValue;
str += '\n\n';
str += ' pValue: ' + roundn( this.pValue, -dgts ) + '\n';
str += ' statistic: ' + roundn( this.statistic, -dgts ) + '\n';
str += '\n';
if ( decision ) {
str += 'Test Decision: ';
if ( this.rejected ) {
str += 'Reject null in favor of alternative at ' + (this.alpha*100) + '% significance level';
} else {
str += 'Fail to reject null in favor of alternative at ' + (this.alpha*100) + '% significance level';
}
str += '\n';
}
return str;
}
// EXPORTS //
module.exports = print;
|