prophet_plot_components.Rd 971 B

12345678910111213141516171819202122232425262728293031
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prophet.R
  3. \name{prophet_plot_components}
  4. \alias{prophet_plot_components}
  5. \title{Plot the components of a prophet forecast.
  6. Prints a ggplot2 with panels for trend, weekly and yearly seasonalities if
  7. present, and holidays if present.}
  8. \usage{
  9. prophet_plot_components(m, fcst, uncertainty = TRUE, plot_cap = TRUE)
  10. }
  11. \arguments{
  12. \item{m}{Prophet object.}
  13. \item{fcst}{Data frame returned by predict(m, df).}
  14. \item{uncertainty}{Boolean indicating if the uncertainty interval should be
  15. plotted for the trend, from fcst columns trend_lower and trend_upper.}
  16. \item{plot_cap}{Boolean indicating if the capacity should be shown in the
  17. figure, if available.}
  18. }
  19. \value{
  20. Invisibly return a list containing the plotted ggplot objects
  21. }
  22. \description{
  23. Plot the components of a prophet forecast.
  24. Prints a ggplot2 with panels for trend, weekly and yearly seasonalities if
  25. present, and holidays if present.
  26. }