Serialize a one-sample Z-test results object as a formatted string.
npm install @stdlib/stats-base-ztest-one-sample-results-to-stringWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Serialize a one-sample Z-test results object as a formatted string.
``bash`
npm install @stdlib/stats-base-ztest-one-sample-results-to-string
`javascript`
var res2str = require( '@stdlib/stats-base-ztest-one-sample-results-to-string' );
#### res2str( results\[, options] )
Serializes a one-sample Z-test results object as a formatted string.
`javascript
var Float64Results = require( '@stdlib/stats-base-ztest-one-sample-results-float64' );
var results = new Float64Results();
// ...
var s = res2str( results );
// returns
`
The function supports the following parameters:
- results: one-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.true
- decision: boolean indicating whether to show the test decision. Default: .
- Example output:
`text
One-sample Z-test
Alternative hypothesis: True mean 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
`
`javascript
var Float64Results = require( '@stdlib/stats-base-ztest-one-sample-results-float64' );
var Float64Array = require( '@stdlib/array-float64' );
var res2str = require( '@stdlib/stats-base-ztest-one-sample-results-to-string' );
var results = new Float64Results();
results.rejected = true;
results.alpha = 0.05;
results.pValue = 0.3364;
results.statistic = 11.7586;
results.nullValue = 0.0;
results.sd = 0.4563;
results.ci = new Float64Array( [ 9.9983, 11.4123 ] );
results.alternative = 'two-sided';
var s = res2str( results );
console.log( s );
`
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-ztest-one-sample-results-to-string.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-ztest-one-sample-results-to-string
[test-image]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-ztest-one-sample-results-to-string/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-ztest-one-sample-results-to-string?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-ztest-one-sample-results-to-string/main/LICENSE