mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-18 08:53:42 +00:00
Update R documentation
This commit is contained in:
parent
c5db6f8619
commit
921b604022
3 changed files with 15 additions and 3 deletions
|
|
@ -6,7 +6,7 @@
|
||||||
components, and prior scale.}
|
components, and prior scale.}
|
||||||
\usage{
|
\usage{
|
||||||
add_seasonality(m, name, period, fourier.order, prior.scale = NULL,
|
add_seasonality(m, name, period, fourier.order, prior.scale = NULL,
|
||||||
mode = NULL)
|
mode = NULL, condition.name = NULL)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet object.}
|
\item{m}{Prophet object.}
|
||||||
|
|
@ -20,6 +20,8 @@ add_seasonality(m, name, period, fourier.order, prior.scale = NULL,
|
||||||
\item{prior.scale}{Optional float prior scale for this component.}
|
\item{prior.scale}{Optional float prior scale for this component.}
|
||||||
|
|
||||||
\item{mode}{Optional 'additive' or 'multiplicative'.}
|
\item{mode}{Optional 'additive' or 'multiplicative'.}
|
||||||
|
|
||||||
|
\item{condition.name}{String name of the seasonality condition.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
The prophet model with the seasonality added.
|
The prophet model with the seasonality added.
|
||||||
|
|
@ -38,4 +40,8 @@ Mode can be specified as either 'additive' or 'multiplicative'. If not
|
||||||
specified, m$seasonality.mode will be used (defaults to 'additive').
|
specified, m$seasonality.mode will be used (defaults to 'additive').
|
||||||
Additive means the seasonality will be added to the trend, multiplicative
|
Additive means the seasonality will be added to the trend, multiplicative
|
||||||
means it will multiply the trend.
|
means it will multiply the trend.
|
||||||
|
|
||||||
|
If condition.name is provided, the dataframe passed to `fit` and `predict`
|
||||||
|
should have a column with the specified condition.name containing booleans
|
||||||
|
which decides when to apply seasonality.
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
\alias{plot_weekly}
|
\alias{plot_weekly}
|
||||||
\title{Plot the weekly component of the forecast.}
|
\title{Plot the weekly component of the forecast.}
|
||||||
\usage{
|
\usage{
|
||||||
plot_weekly(m, uncertainty = TRUE, weekly_start = 0)
|
plot_weekly(m, uncertainty = TRUE, weekly_start = 0, name = "weekly")
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model object}
|
\item{m}{Prophet model object}
|
||||||
|
|
@ -14,6 +14,9 @@ plot_weekly(m, uncertainty = TRUE, weekly_start = 0)
|
||||||
\item{weekly_start}{Integer specifying the start day of the weekly
|
\item{weekly_start}{Integer specifying the start day of the weekly
|
||||||
seasonality plot. 0 (default) starts the week on Sunday. 1 shifts by 1 day
|
seasonality plot. 0 (default) starts the week on Sunday. 1 shifts by 1 day
|
||||||
to Monday, and so on.}
|
to Monday, and so on.}
|
||||||
|
|
||||||
|
\item{name}{Name of seasonality component if previously changed
|
||||||
|
from default 'weekly'.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A ggplot2 plot.
|
A ggplot2 plot.
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
\alias{plot_yearly}
|
\alias{plot_yearly}
|
||||||
\title{Plot the yearly component of the forecast.}
|
\title{Plot the yearly component of the forecast.}
|
||||||
\usage{
|
\usage{
|
||||||
plot_yearly(m, uncertainty = TRUE, yearly_start = 0)
|
plot_yearly(m, uncertainty = TRUE, yearly_start = 0, name = "yearly")
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model object.}
|
\item{m}{Prophet model object.}
|
||||||
|
|
@ -14,6 +14,9 @@ plot_yearly(m, uncertainty = TRUE, yearly_start = 0)
|
||||||
\item{yearly_start}{Integer specifying the start day of the yearly
|
\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
|
seasonality plot. 0 (default) starts the year on Jan 1. 1 shifts by 1 day
|
||||||
to Jan 2, and so on.}
|
to Jan 2, and so on.}
|
||||||
|
|
||||||
|
\item{name}{Name of seasonality component if previously changed
|
||||||
|
from default 'yearly'.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A ggplot2 plot.
|
A ggplot2 plot.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue