About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

res2str

Serialize a two-sample Z-test results object as a formatted string.

Installation

npm install @stdlib/stats-base-ztest-two-sample-results-to-string

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var res2str = require( '@stdlib/stats-base-ztest-two-sample-results-to-string' );

res2str( results[, options] )

Serializes a two-sample Z-test results object as a formatted string.

var Float64Results = require( '@stdlib/stats-base-ztest-two-sample-results-float64' );

var results = new Float64Results();

// ...

var s = res2str( results );
// returns <string>

The function supports the following parameters:

• results: two-sample Z-test results object.
• options: function options.

The function supports the following options:

• digits: number of digits to display after decimal points. Default: 4.
• decision: boolean indicating whether to show the test decision. Default: true.

Notes

• Example output:

  
  Two-sample Z-test
  
  Alternative hypothesis: True difference in means is less than 1.0
  
      pValue: 0.0406
      statistic: 9.9901
      95% confidence interval: [9.7821, 10.4451]
  
  Test Decision: Reject null in favor of alternative at 5% significance level
  
  

Examples

var Float64Results = require( '@stdlib/stats-base-ztest-two-sample-results-float64' );
var resolveEnum = require( '@stdlib/stats-base-ztest-alternative-resolve-enum' );
var Float64Array = require( '@stdlib/array-float64' );
var res2str = require( '@stdlib/stats-base-ztest-two-sample-results-to-string' );

var results = new Float64Results();
results.rejected = true;
results.alpha = 0.05;
results.pValue = 0.0132;
results.statistic = 2.4773;
results.nullValue = 0.0;
results.xmean = 3.7561;
results.ymean = 3.0129;
results.ci = new Float64Array( [ 0.1552, 1.3311 ] );
results.alternative = resolveEnum( 'two-sided' );

var s = res2str( results );
console.log( s );

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

Copyright

Copyright © 2016-2025. The Stdlib Authors.