mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-05-29 23:06:49 +00:00
35 lines
924 B
R
35 lines
924 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/utils.R
|
|
\name{layer_changepoints}
|
|
\alias{layer_changepoints}
|
|
\title{Get layers to overlay significant changepoints on prophet forecast plot.}
|
|
\usage{
|
|
layer_changepoints(m, threshold = 0.01, cp_color = "red",
|
|
cp_linetype = "dashed", trend = TRUE, ...)
|
|
}
|
|
\arguments{
|
|
\item{m}{Prophet model object.}
|
|
|
|
\item{threshold}{Numeric, changepoints where abs(delta) >= threshold are
|
|
significant. (Default 0.01)}
|
|
|
|
\item{cp_color}{Character, line color. (Default "red")}
|
|
|
|
\item{cp_linetype}{Character or integer, line type. (Default "dashed")}
|
|
|
|
\item{trend}{Logical, if FALSE, do not draw trend line. (Default TRUE)}
|
|
|
|
\item{...}{Other arguments passed on to layers.}
|
|
}
|
|
\value{
|
|
A list of ggplot2 layers.
|
|
}
|
|
\description{
|
|
Get layers to overlay significant changepoints on prophet forecast plot.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
plot(m, fcst) + layer_changepoints(m)
|
|
}
|
|
|
|
}
|