stdDev

This function is used by Ignition's Expression language.

Description

Calculates the sample standard deviation of the values in the given column of the given dataset, or the standard deviation for a series of numbers specified as arguments. When looking up the standard deviation in a dataset, the column may be specified as an index or as a column name. Any null values in the column are ignored. If there are no rows in the dataset, null is returned.

Syntax

stdDev(dataset, columnIndex)

• Parameters

  • DataSet dataset - The dataset to search through.

  • int columnIndex - The index of the column to search through. Must be a column index of the provided dataset.

• Returns

  • int/float - The standard deviation of the values in that column.

Syntax

stdDev(dataset, columnName)

• Parameters

  • DataSet dataset - The dataset to search through.

  • string columnName - The name of the column to search through. Must match a column name in the provided dataset.

• Returns

  • int/float - The standard deviation of the values in that column.

Syntax

stdDev(value[, value...])

• Parameters

  • int/float value - A number. Can be as many values as needed. Can be either a float or an integer.

• Returns

  • int/float - The standard deviation of the values in the list of values.

Examples

For example, suppose you had a table with this dataset in it:

ProductCode	Quantity	Weight
BAN_002	380	3.243
BAN_010	120	9.928
APL_000	125	1.287
FWL_220	322	7.889

Code Snippet

stdDev({Root Container.Table.data}, "Weight") //... would return 4.00532