atoti.agg.var module#

atoti.agg.var(operand: ColumnOrOperationOrLevel, /, *, mode: Literal['sample', 'population'] = "'sample'") → MeasureDescription#
atoti.agg.var(operand: MeasureDescription, /, *, mode: Literal['sample', 'population'] = "'sample'", scope: Scope) → MeasureDescription

Return a measure equal to the variance of the passed operand across the specified scope.

Parameters

  • operand (Union[Column, Operation, Level, MeasureDescription]) – The operand to get the variance of.

  • mode (Literal[‘sample’, ‘population’]) –

    One of the supported modes:

    • The sample variance, similar to Excel’s VAR.S, is \(\frac{\sum_{i=1}^{n} (X_i - m)^{2}}{n - 1}\) where m is the sample mean and n the size of the sample. Use this mode if the data represents a sample of the population.

    • The population variance, similar to Excel’s VAR.P is \(\frac{\sum_{i=1}^{n}(X_i - m)^{2}}{n}\) where m is the mean of the Xi elements and n the size of the population. Use this mode if the data represents the entire population.

  • scope (Union[CumulativeScope, OriginScope, SiblingsScope, None]) – The scope of the aggregation.

Return type

MeasureDescription