diff --git a/R/.Rbuildignore b/R/.Rbuildignore index f2dea5f..88a6c9e 100644 --- a/R/.Rbuildignore +++ b/R/.Rbuildignore @@ -1 +1,2 @@ ^data-raw$ +^libs$ diff --git a/R/DESCRIPTION b/R/DESCRIPTION index b7742fa..4b21935 100644 --- a/R/DESCRIPTION +++ b/R/DESCRIPTION @@ -30,12 +30,13 @@ Imports: Suggests: knitr, testthat, - readr + readr, + rmarkdown License: MIT + file LICENSE URL: https://github.com/facebook/prophet BugReports: https://github.com/facebook/prophet/issues LazyData: true -RoxygenNote: 6.1.1 +RoxygenNote: 7.0.2 VignetteBuilder: knitr SystemRequirements: C++11 Encoding: UTF-8 diff --git a/R/man/add_changepoints_to_plot.Rd b/R/man/add_changepoints_to_plot.Rd index 96dad1d..d1161fd 100644 --- a/R/man/add_changepoints_to_plot.Rd +++ b/R/man/add_changepoints_to_plot.Rd @@ -4,8 +4,14 @@ \alias{add_changepoints_to_plot} \title{Get layers to overlay significant changepoints on prophet forecast plot.} \usage{ -add_changepoints_to_plot(m, threshold = 0.01, cp_color = "red", - cp_linetype = "dashed", trend = TRUE, ...) +add_changepoints_to_plot( + m, + threshold = 0.01, + cp_color = "red", + cp_linetype = "dashed", + trend = TRUE, + ... +) } \arguments{ \item{m}{Prophet model object.} diff --git a/R/man/add_regressor.Rd b/R/man/add_regressor.Rd index 39e16a1..622ee65 100644 --- a/R/man/add_regressor.Rd +++ b/R/man/add_regressor.Rd @@ -4,8 +4,7 @@ \alias{add_regressor} \title{Add an additional regressor to be used for fitting and predicting.} \usage{ -add_regressor(m, name, prior.scale = NULL, standardize = "auto", - mode = NULL) +add_regressor(m, name, prior.scale = NULL, standardize = "auto", mode = NULL) } \arguments{ \item{m}{Prophet object.} diff --git a/R/man/add_seasonality.Rd b/R/man/add_seasonality.Rd index ce2fdea..7f6591f 100644 --- a/R/man/add_seasonality.Rd +++ b/R/man/add_seasonality.Rd @@ -5,8 +5,15 @@ \title{Add a seasonal component with specified period, number of Fourier components, and prior scale.} \usage{ -add_seasonality(m, name, period, fourier.order, prior.scale = NULL, - mode = NULL, condition.name = NULL) +add_seasonality( + m, + name, + period, + fourier.order, + prior.scale = NULL, + mode = NULL, + condition.name = NULL +) } \arguments{ \item{m}{Prophet object.} diff --git a/R/man/plot.prophet.Rd b/R/man/plot.prophet.Rd index f20f2f7..e8cc981 100644 --- a/R/man/plot.prophet.Rd +++ b/R/man/plot.prophet.Rd @@ -4,8 +4,15 @@ \alias{plot.prophet} \title{Plot the prophet forecast.} \usage{ -\method{plot}{prophet}(x, fcst, uncertainty = TRUE, plot_cap = TRUE, - xlabel = "ds", ylabel = "y", ...) +\method{plot}{prophet}( + x, + fcst, + uncertainty = TRUE, + plot_cap = TRUE, + xlabel = "ds", + ylabel = "y", + ... +) } \arguments{ \item{x}{Prophet object.} diff --git a/R/man/plot_forecast_component.Rd b/R/man/plot_forecast_component.Rd index f4e18d1..f17de5e 100644 --- a/R/man/plot_forecast_component.Rd +++ b/R/man/plot_forecast_component.Rd @@ -4,8 +4,7 @@ \alias{plot_forecast_component} \title{Plot a particular component of the forecast.} \usage{ -plot_forecast_component(m, fcst, name, uncertainty = TRUE, - plot_cap = FALSE) +plot_forecast_component(m, fcst, name, uncertainty = TRUE, plot_cap = FALSE) } \arguments{ \item{m}{Prophet model} diff --git a/R/man/prophet.Rd b/R/man/prophet.Rd index bf6ea22..618b351 100644 --- a/R/man/prophet.Rd +++ b/R/man/prophet.Rd @@ -4,14 +4,26 @@ \alias{prophet} \title{Prophet forecaster.} \usage{ -prophet(df = NULL, growth = "linear", changepoints = NULL, - n.changepoints = 25, changepoint.range = 0.8, - yearly.seasonality = "auto", weekly.seasonality = "auto", - daily.seasonality = "auto", holidays = NULL, - seasonality.mode = "additive", seasonality.prior.scale = 10, - holidays.prior.scale = 10, changepoint.prior.scale = 0.05, - mcmc.samples = 0, interval.width = 0.8, uncertainty.samples = 1000, - fit = TRUE, ...) +prophet( + df = NULL, + growth = "linear", + changepoints = NULL, + n.changepoints = 25, + changepoint.range = 0.8, + yearly.seasonality = "auto", + weekly.seasonality = "auto", + daily.seasonality = "auto", + holidays = NULL, + seasonality.mode = "additive", + seasonality.prior.scale = 10, + holidays.prior.scale = 10, + changepoint.prior.scale = 0.05, + mcmc.samples = 0, + interval.width = 0.8, + uncertainty.samples = 1000, + fit = TRUE, + ... +) } \arguments{ \item{df}{(optional) Dataframe containing the history. Must have columns ds diff --git a/R/man/prophet_plot_components.Rd b/R/man/prophet_plot_components.Rd index d954761..fe7ab1e 100644 --- a/R/man/prophet_plot_components.Rd +++ b/R/man/prophet_plot_components.Rd @@ -7,8 +7,15 @@ Prints a ggplot2 with whichever are available of: trend, holidays, weekly 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, render_plot = TRUE) +prophet_plot_components( + m, + fcst, + uncertainty = TRUE, + plot_cap = TRUE, + weekly_start = 0, + yearly_start = 0, + render_plot = TRUE +) } \arguments{ \item{m}{Prophet object.} diff --git a/R/man/validate_column_name.Rd b/R/man/validate_column_name.Rd index 1b43711..4861e8f 100644 --- a/R/man/validate_column_name.Rd +++ b/R/man/validate_column_name.Rd @@ -4,8 +4,13 @@ \alias{validate_column_name} \title{Validates the name of a seasonality, holiday, or regressor.} \usage{ -validate_column_name(m, name, check_holidays = TRUE, - check_seasonalities = TRUE, check_regressors = TRUE) +validate_column_name( + m, + name, + check_holidays = TRUE, + check_seasonalities = TRUE, + check_regressors = TRUE +) } \arguments{ \item{m}{Prophet object.}