diff --git a/R/man/add_seasonality.Rd b/R/man/add_seasonality.Rd index dc6ef98..ce2fdea 100644 --- a/R/man/add_seasonality.Rd +++ b/R/man/add_seasonality.Rd @@ -6,7 +6,7 @@ components, and prior scale.} \usage{ add_seasonality(m, name, period, fourier.order, prior.scale = NULL, - mode = NULL) + mode = NULL, condition.name = NULL) } \arguments{ \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{mode}{Optional 'additive' or 'multiplicative'.} + +\item{condition.name}{String name of the seasonality condition.} } \value{ 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'). Additive means the seasonality will be added to the trend, multiplicative 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. } diff --git a/R/man/plot_weekly.Rd b/R/man/plot_weekly.Rd index 6092345..d0f5a1e 100644 --- a/R/man/plot_weekly.Rd +++ b/R/man/plot_weekly.Rd @@ -4,7 +4,7 @@ \alias{plot_weekly} \title{Plot the weekly component of the forecast.} \usage{ -plot_weekly(m, uncertainty = TRUE, weekly_start = 0) +plot_weekly(m, uncertainty = TRUE, weekly_start = 0, name = "weekly") } \arguments{ \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 seasonality plot. 0 (default) starts the week on Sunday. 1 shifts by 1 day to Monday, and so on.} + +\item{name}{Name of seasonality component if previously changed +from default 'weekly'.} } \value{ A ggplot2 plot. diff --git a/R/man/plot_yearly.Rd b/R/man/plot_yearly.Rd index 7a227ed..771080e 100644 --- a/R/man/plot_yearly.Rd +++ b/R/man/plot_yearly.Rd @@ -4,7 +4,7 @@ \alias{plot_yearly} \title{Plot the yearly component of the forecast.} \usage{ -plot_yearly(m, uncertainty = TRUE, yearly_start = 0) +plot_yearly(m, uncertainty = TRUE, yearly_start = 0, name = "yearly") } \arguments{ \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 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.