docs-v2/content/flux/v0/stdlib/universe/highestaverage.md

title	description	menu	weight	flux/v0/tags	introduced
highestAverage() function	`highestAverage()` calculates the average of each input table and returns the highest `n` averages.	flux_v0_ref name parent identifier highestAverage universe universe/highestAverage	101	transformations selectors	0.7.0

highestAverage() calculates the average of each input table and returns the highest n averages.

Note: highestAverage() drops empty tables.

Function type signature

(<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[B] where A: Record, B: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

n

({{< req >}}) Number of records to return.

column

Column to evaluate. Default is _value.

groupColumns

List of columns to group by. Default is [].

tables

Input data. Default is piped-forward data (<-).

Examples

Return the highest table average from a stream of tables

import "sampledata"

sampledata.int()
    |> highestAverage(n: 1, groupColumns: ["tag"])

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time	_value	*tag
2021-01-01T00:00:00Z	-2	t1
2021-01-01T00:00:10Z	10	t1
2021-01-01T00:00:20Z	7	t1
2021-01-01T00:00:30Z	17	t1
2021-01-01T00:00:40Z	15	t1
2021-01-01T00:00:50Z	4	t1

_time	_value	*tag
2021-01-01T00:00:00Z	19	t2
2021-01-01T00:00:10Z	4	t2
2021-01-01T00:00:20Z	-3	t2
2021-01-01T00:00:30Z	19	t2
2021-01-01T00:00:40Z	13	t2
2021-01-01T00:00:50Z	1	t2

Output data

tag	_value
t2	8.833333333333334

{{% /expand %}} {{< /expand-wrapper >}}