median
agg.median returns an aggregator that computes the median value, within an aggregation group, for each input column.
Syntax
Parameters
| Parameter | Type | Description |
|---|---|---|
| cols | Union[str, list[str]] | The source column(s) for the calculations.
|
| average_evenly_divided | bool | When the group size is an even number, whether to average the two middle values for the output value.
|
Caution
If an aggregation does not rename the resulting column, the aggregation column will appear in the output table, not the input column. If multiple aggregations on the same column do not rename the resulting columns, an error will result, because the aggregations are trying to create multiple columns with the same name. For example, in table.agg_by([agg.sum_(cols=[“X”]), agg.avg(cols=["X"]), both the sum and the average aggregators produce column X, which results in an error.
Returns
An aggregator that computes the median value, within an aggregation group, for each input column.
Examples
In this example, agg.median returns the median Number value as grouped by X.
In this example, agg.median returns the median Number value (renamed to Z), as grouped by X.
In this example, agg.median returns the median Number, as grouped by X and Y.
In this example, agg.median returns the median Number, and agg.max_ returns the maximum Number, as grouped by X.
This example demonstrates the effect of the average_evenly_divided parameter. The first table returns the median Number with average_evenly_divided set to False; the second table shows the default behavior.