QUANTILE

Description

Calculates the quantile value on a set of numbers or event values, based on specified quantile.

Remark: to obtain the median value on an array, you can use the QUANTILE function with parameter 0.5 (i. e. the 50% quantile).

QUANTILE(Vector<Number/Event>, Scalar<Number>)

QUANTILE(vector: Vector<Number/Event>, Scalar<Number>): Scalar<Number>

Parameters

Parameter	Description
vector	A vector of type <Number/Event>
quantile	Quantile of type <Number>, with value range [0, 1]

Returns

Returns the quantile value as Scalar<Number>

---

QUANTILE(GroupedScalar<any, Number/Event>, Scalar<Number>)

QUANTILE(group: GroupedScalar<any, Number/Event>): Scalar<Number>

Parameters

Parameter	Description
group	A GroupedScalar of type <any, Number/Event>
quantile	Quantile of type <Number>, with value range [0, 1]

Returns

Returns the quantile value as Scalar<Number>

---

QUANTILE(GroupedVector<any, Number/Event>, Scalar<Number>)

QUANTILE(group: GroupedVector<any, Number/Event>): GroupedScalar<Number>

Parameters

Parameter	Description
group	A GroupedVector of type <any, Number/Event>
quantile	Quantile of type <Number>, with value range [0, 1]

Returns

Returns the quantile value as GroupedScalar<any, Number>

---

Examples

Retrieve the 50% percentile of the GridPowerConsumption time series.

QUANTILE($GridPowerConsumption, 0.5)