Dep for building the vignette + ignore libs + rebuild docs

This commit is contained in:
Sean Taylor 2020-02-27 12:19:34 -08:00
parent 83e2479699
commit 192b9160a7
10 changed files with 68 additions and 24 deletions

View file

@ -1 +1,2 @@
^data-raw$
^libs$

View file

@ -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

View file

@ -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.}

View file

@ -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.}

View file

@ -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.}

View file

@ -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.}

View file

@ -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}

View file

@ -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

View file

@ -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.}

View file

@ -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.}