prophet: add_changepoints_to_plot – R documentation

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

add_changepoints_to_plot

Get layers to overlay significant changepoints on prophet forecast plot.

Get layers to overlay significant changepoints on prophet forecast plot.

add_changepoints_to_plot(
  m,
  threshold = 0.01,
  cp_color = "red",
  cp_linetype = "dashed",
  trend = TRUE,
  ...
)

`m`	Prophet model object.
`threshold`	Numeric, changepoints where abs(delta) >= threshold are significant. (Default 0.01)
`cp_color`	Character, line color. (Default "red")
`cp_linetype`	Character or integer, line type. (Default "dashed")
`trend`	Logical, if FALSE, do not draw trend line. (Default TRUE)
`...`	Other arguments passed on to layers.

A list of ggplot2 layers.

## Not run: 
plot(m, fcst) + add_changepoints_to_plot(m)

## End(Not run)

Automatic Forecasting Procedure

v1.0

MIT + file LICENSE

Authors

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

Initial release

2021-03-08