arrayAverage.md

Back to reference

arrayAverage(arr, ignoreEmpty = false)

Calculates the average value of all elements in an array of numbers arr. If the optional argument ignoreEmpty is set to false (default value), invalid numerical values in the array are regarded as 0. If ignoreEmpty is set to true, the average is calculated only among all valid numerical values.

Note: Valid numerical values are all values that can be cast to a Number. E.g. the array [1, 2] is invalid while the string "2" is valid.

Examples:

Example 1:

If you have an array like this:

const someNumbers = [1, 2, 3, 4, 5];

This will calculate the average values of someNumbers, which is 3:

let average = gmynd.arrayAverage(someNumbers);

// 3

Example 2:

Let's assume you have a slightly different array like this one:

const someNumbers = [1, 2, 3, 4, 5, null];

This will calculate the average value of someNumbers, ignoring the value null in the array:

let average = gmynd.arrayAverage(someNumbers, true);

// 3

If you want this null value to be calculated into the average value as a 0, just do this:

let average = gmynd.arrayAverage(someNumbers);

// 2.5

Note: In this case you could also write:

let average = gmynd.arrayAverage(someNumbers, false);

This leads to the same result as ignoreEmpty is already set to false by default.

Example 3:

Here another array:

const someNumbers = [1, 2, 3, 4, 5, [6, 7]];

This will calculate the average value of someNumbers, ignoring the array [6, 7] in the array:

let average = gmynd.arrayAverage(someNumbers, true);

// 3

This is because the values 6 and 7 are numeric, but the array itself cannot be cast as a Number, and is therefore invalid.