Function reference · Statistics
zscore
Computes a value's z-score from a mean and standard deviation.
zscore(x, average, standardDeviation) returns (x-average)/standardDeviation. The average and standard deviation are supplied explicitly; this function does not estimate them from a dataset.
Examples
These examples use Nerdamer Notation.
Measure a value one standard deviation above the mean.
zscore(7,5,2)
// → 1Interfaces
The same operation is available through the interfaces below.
Nerdamer Notation
Use this form inside input passed to nerdamer(...).
zscore(arg1, arg2, arg3)
nerdamer.zscore
Call the operation through the default nerdamer import.
nerdamer.zscore(x: ExpressionInput, average: ExpressionInput, standardDeviation: ExpressionInput): Expression
Parameters
| Name | Type | Description |
|---|---|---|
x | ExpressionInput | — |
average | ExpressionInput | — |
standardDeviation | ExpressionInput | — |
Returns
Direct JavaScript / TypeScript API
Import the operation directly from its package entry point.
import { zscore } from 'nerdamer/statistics';
zscore(x: ExpressionInput, average: ExpressionInput, standardDeviation: ExpressionInput): Expression
Parameters
| Name | Type | Description |
|---|---|---|
x | ExpressionInput | — |
average | ExpressionInput | — |
standardDeviation | ExpressionInput | — |
