Produce forecasts from the prophet model

Source: R/model.R

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.

# S3 method for 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 boostrap = TRUE.
...

Additional arguments passed to prophet::predict.prophet().

Value

A list of forecasts.

See also

prophet::predict.prophet()

Examples


# \donttest{
if (requireNamespace("tsibbledata")) {
library(tsibble)
tsibbledata::aus_production %>%
  model(
    prophet = prophet(Beer ~ season("year", 4, type = "multiplicative"))
  ) %>%
  forecast()
}
#> # A fable: 8 x 4 [1Q]
#> # Key:     .model [1]
#>   .model  Quarter         Beer .mean
#>   <chr>     <qtr>       <dist> <dbl>
#> 1 prophet 2010 Q3 sample[1000]  392.
#> 2 prophet 2010 Q4 sample[1000]  490.
#> 3 prophet 2011 Q1 sample[1000]  421.
#> 4 prophet 2011 Q2 sample[1000]  377.
#> 5 prophet 2011 Q3 sample[1000]  390.
#> 6 prophet 2011 Q4 sample[1000]  488.
#> 7 prophet 2012 Q1 sample[1000]  420.
#> 8 prophet 2012 Q2 sample[1000]  376.
# }