VARPA

Calculates variance based on the entire population, including logical values and text. Text and the -false logical value have the value 0; the -true logical value has the value 1.

Syntax

expression.VARPA(args);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
args	Required	number | string | boolean | (number | string | boolean)[] | ApiRange | ApiName		Up to 255 values for which the variance will be calculated. The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values or text representations of numbers, names, ranges, or arrays.

Returns

number

Example

This example shows how to calculate variance based on the entire population, including logical values and text. Text and the false logical value have the value 0; the true logical value has the value 1.

• Code
• Result

// How to estimate variance based on the entire population considering logical values and text.

// Use a function to estimate variance based on population not ignoring logical values and text.


let worksheet = Api.GetActiveSheet();

// Data array
let data = [
    [1, 0, 0, false],
    ["text", 1, 0, 0],
    [2, 3, true, 7],
    [6, 8, 10, 12]
];

// Place the data in cells A1:D4
for (let i = 0; i < data.length; i++) {
    for (let j = 0; j < data[i].length; j++) {
        worksheet.GetRangeByNumber(i, j).SetValue(data[i][j]);
    }
}

// Calculate the letPA of the range A1:D4 and place the result in cell D5
let func = Api.GetWorksheetFunction();
let letpaResult = func.VARPA(worksheet.GetRange("A1:D4"));
worksheet.GetRange("D5").SetValue(letpaResult);