out_table.TableRenderer.quantiles

tools.out_table.TableRenderer.quantiles(
    quantiles,
    geo,
    time,
    quantity,
    *,
    ordering='location',
    result_format='dataframe',
    column_names=None,
)

Renders a table showing time-series quantiles for the given selections.

Parameters

quantiles: Sequence[float]: the list of quantiles to calculate and display, in the range [0,1]
geo: GeoSelection | GeoAggregation: the geographic selection to make on the output data
time: TimeSelection | TimeAggregation: the time selection to make on the output data
quantity: QuantitySelection | QuantityAggregation: the quantity selection to make on the output data
ordering: (location, quantity) = “location”: controls the ordering of rows in the result; both location and quantity are used to sort the resulting rows, this just decides which gets priority
result_format: (dataframe, string, print) = “dataframe”: controls the type of the result of this method; “dataframe” returns a Pandas DataFrame, “string” returns the stringified table, and “print” just prints the stringified table directly and returns None
column_names: Sequence[str] = None: overrides the default names of the quantiles columns; by default, this is just the quantile value itself

Returns

DataFrame | str | None: according to the value of the result_format parameter