components.fbl_prophet: Extract meaningful components

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

Extract meaningful components

Description

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.

Usage

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

Arguments

object	An estimated model.
...	Unused.

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().

Value

A fabletools::dable() containing estimated states.

Examples

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()
}

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