Extract meaningful components

A prophet model consists of terms which are additively or multiplicatively included in the model. Multiplicative terms are scaled proportionally to the estimated trend, while additive terms are not.

# S3 method for fbl_prophet
components(object, ...)

Arguments

object	An estimated model.
...	Unused.

Value

A fabletools::dable() containing estimated states.

Details

Extracting a prophet model's components using this function allows you to visualise the components in a similar way to prophet::prophet_plot_components().

Examples

# \donttest{
if (requireNamespace("tsibbledata")) {
library(tsibble)
beer_components <- tsibbledata::aus_production %>%
  model(
    prophet = prophet(Beer ~ season("year", 4, type = "multiplicative"))
  ) %>%
  components()

beer_components

autoplot(beer_components)

library(ggplot2)
library(lubridate)
beer_components %>%
  ggplot(aes(x = quarter(Quarter), y = year, group = year(Quarter))) +
  geom_line()
}
#> Loading required namespace: tsibbledata
#> 
#> Attaching package: ‘lubridate’
#> The following object is masked from ‘package:tsibble’:
#> 
#>     interval
#> The following objects are masked from ‘package:base’:
#> 
#>     date, intersect, setdiff, union
# }