prophet: prophet_plot_components – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

prophet_plot_components

Plot the components of a prophet forecast. Prints a ggplot2 with whichever are available of: trend, holidays, weekly seasonality, yearly seasonality, and additive and multiplicative extra regressors.

Description

Plot the components of a prophet forecast. Prints a ggplot2 with whichever are available of: trend, holidays, weekly seasonality, yearly seasonality, and additive and multiplicative extra regressors.

Usage

prophet_plot_components(
  m,
  fcst,
  uncertainty = TRUE,
  plot_cap = TRUE,
  weekly_start = 0,
  yearly_start = 0,
  render_plot = TRUE
)

Arguments

`m`	Prophet object.
`fcst`	Data frame returned by predict(m, df).
`uncertainty`	Optional boolean indicating if the uncertainty interval should be plotted for the trend, from fcst columns trend_lower and trend_upper.This will only be done if m$uncertainty.samples > 0.
`plot_cap`	Boolean indicating if the capacity should be shown in the figure, if available.
`weekly_start`	Integer specifying the start day of the weekly seasonality plot. 0 (default) starts the week on Sunday. 1 shifts by 1 day to Monday, and so on.
`yearly_start`	Integer specifying the start day of the yearly seasonality plot. 0 (default) starts the year on Jan 1. 1 shifts by 1 day to Jan 2, and so on.
`render_plot`	Boolean indicating if the plots should be rendered. Set to FALSE if you want the function to only return the list of panels.

Value

Invisibly return a list containing the plotted ggplot objects

prophet

Automatic Forecasting Procedure

v1.0

MIT + file LICENSE

Authors

Sean Taylor [cre, aut], Ben Letham [aut]

Initial release

2021-03-08