saymrwulf/prophet
1
0
Fork 0
mirror of https://github.com/saymrwulf/prophet.git synced 2026-07-30 20:18:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation update for new plot_components arg

Browse source
This commit is contained in:
Ben Letham 2018-05-31 17:45:44 -07:00
parent e5967a541e
commit 9a5338cbe4
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
R/man/prophet_plot_components.Rd
View file

@ -8,7 +8,7 @@ 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)
weekly_start = 0, yearly_start = 0, render_plot = TRUE)
}
\arguments{
\item{m}{Prophet object.}
@ -28,6 +28,9 @@ to Monday, and so on.}
\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{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