forecast.fbl_prophet: Produce forecasts from the prophet model

In mitchelloharawild/fable.prophet: Prophet Modelling Interface for 'fable'

Produce forecasts from the prophet model

Description

If additional future information is required (such as exogenous variables or carrying capacities) by the model, then they should be included as variables of the new_data argument.

Usage

## S3 method for class 'fbl_prophet'
forecast(object, new_data, specials = NULL, times = 1000, ...)

Arguments

object	The time series model used to produce the forecasts
new_data	A tsibble containing future information used to forecast.
specials	(passed by fabletools::forecast.mdl_df()).
times	The number of sample paths to use in estimating the forecast distribution when bootstrap = TRUE.
...	Additional arguments passed to prophet::predict.prophet().

Value

A list of forecasts.

See Also

prophet::predict.prophet()

Examples

if (requireNamespace("tsibbledata")) {
library(tsibble)
tsibbledata::aus_production %>%
  model(
    prophet = prophet(Beer ~ season("year", 4, type = "multiplicative"))
  ) %>%
  forecast()
}

mitchelloharawild/fable.prophet documentation built on Oct. 17, 2023, 11:22 a.m.