plot.forecast_error {forecastML}

Plot forecast error

Description

Plot forecast error at various levels of aggregation.

Usage

## S3 method for class 'forecast_error'
plot(
  x,
  type = c("global"),
  metric = NULL,
  facet = NULL,
  models = NULL,
  horizons = NULL,
  windows = NULL,
  group_filter = NULL,
  ...
)

Arguments

x

An object of class 'forecast_error' from return_error().

type

Select plot type; type = "global" is the default plot.

metric

Select error metric to plot (e.g., "mae"); attributes(x)$error_metrics[1] is the default metric.

facet

Optional. A formula with any combination of horizon, model, or group (for grouped time series). passed to ggplot2::facet_grid() internally (e.g., horizon ~ model, horizon + model ~ ., ~ horizon + group). Can be NULL. The default faceting is set internally depending on the plot type.

models

Optional. A vector of user-defined model names from train_model() to filter results.

horizons

Optional. A numeric vector to filter results by horizon.

windows

Optional. A numeric vector to filter results by validation window number.

group_filter

A string for filtering plot results for grouped time series (e.g., "group_col_1 == 'A'").

...

Not used.

Value

Forecast error plots of class 'ggplot'.