R/autoplot.R

In mlr-org/mlr3forecasting: Forecasting for 'mlr3'

#' @title Plot for Forecast Tasks
#'
#' @description
#' Generates plots for [mlr3temporal::TaskForecast].
#'
#' @param object ([mlr3temporal::TaskForecast]).
#' @param ... (`any`):
#'   Additional argument, passed down to the underlying `geom` or plot functions.
#'
#' @return [ggplot2::ggplot()] object.
#' @export
#' @examples
#' library(mlr3)
#' library(mlr3temporal)
#' library(ggplot2)
#'
#' task = tsk("airpassengers")
#' autoplot(task)
#'
#' task = tsk("petrol")
#' autoplot(task)
autoplot.TaskForecast = function(object, ...) { # nolint
  require_namespaces("ggplot2")
  data = data.table(object$data(), object$date())
  date = object$date_col
  target = object$target_names
  data_long = melt(data, id.vars = date, measure.vars = target)

  ggplot2::ggplot(data_long, ggplot2::aes_string(x = date)) +
    ggplot2::geom_line(ggplot2::aes_string(y = "value", col = "variable")) +
    ggplot2::xlab("")
}