mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-05-17 21:10:45 +00:00
28 lines
781 B
R
28 lines
781 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/plot.R
|
|
\name{plot_yearly}
|
|
\alias{plot_yearly}
|
|
\title{Plot the yearly component of the forecast.}
|
|
\usage{
|
|
plot_yearly(m, uncertainty = TRUE, yearly_start = 0, name = "yearly")
|
|
}
|
|
\arguments{
|
|
\item{m}{Prophet model object.}
|
|
|
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which
|
|
will only be done if m$uncertainty.samples > 0.}
|
|
|
|
\item{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.}
|
|
|
|
\item{name}{Name of seasonality component if previously changed
|
|
from default 'yearly'.}
|
|
}
|
|
\value{
|
|
A ggplot2 plot.
|
|
}
|
|
\description{
|
|
Plot the yearly component of the forecast.
|
|
}
|
|
\keyword{internal}
|