avgBy

avgBy returns the average (mean) of each non-key column for each group. Null values are ignored.

Caution

Applying this aggregation to a column where the average cannot be computed will result in an error. For example, the average is not defined for a column of string values.

Syntax

Parameters

ParameterTypeDescription
groupByColumnsString...

The column(s) by which to group data.

  • NULL returns total average for all non-key columns.
  • "X" will output the total average of each group in column X.
  • "X", "Y" will output the total average of each group designated from the X and Y columns.
groupByColumnsCollection<String>

The column(s) by which to group data.

  • NULL returns total average for all non-key columns.
  • "X" will output the total average of each group in column X.
  • "X", "Y" will output the total average of each group designated from the X and Y columns.
groupByColumnsColumnName

The column(s) by which to group data.

  • NULL returns total average for all non-key columns.
  • "X" will output the total average of each group in column X.
  • "X", "Y" will output the total average of each group designated from the X and Y columns.

Returns

A new table containing the average for each group.

Examples

In this example, avgBy returns the average value for the table. Because an average cannot be computed for the string columns X and Y, these columns are dropped before applying avgBy.

In this example, avgBy returns the average value, as grouped by X. Because an average cannot be computed for the string column Y, this column is dropped before applying avgBy.

In this example, avgBy returns the average value, as grouped by X and Y.