STANDARDIZE

Returns a normalised value from a distribution characterised by a mean and standard deviation.

Syntax

expression.STANDARDIZE(arg1, arg2, arg3);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
arg1	Required	ApiRange | ApiName | number		The value to normalize.
arg2	Required	ApiRange | ApiName | number		The arithmetic mean of the distribution.
arg3	Required	ApiRange | ApiName | number		The standard deviation of the distribution, a positive number.

Returns

number

Example

Calculate a normalized value from a distribution with mean and standard deviation.

// The STANDARDIZE function converts a value to a z-score using the distribution's mean and standard deviation.

// Get the normalized value and place it in cell C1.

const worksheet = Api.GetActiveSheet();

let valueArr = [5, -2, 10];

// Place the numbers in cells
for (let i = 0; i < valueArr.length; i++) {
  worksheet.GetRange("A" + (i + 1)).SetValue(valueArr[i]);
}

// method params
let x = worksheet.GetRange("A1");
let mean = worksheet.GetRange("A2");
let stdDev = worksheet.GetRange("A3");

let func = Api.WorksheetFunction;
let ans = func.STANDARDIZE(x, mean, stdDev);

worksheet.GetRange("C1").SetValue(ans);