mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-18 08:53:42 +00:00
Dep for building the vignette + ignore libs + rebuild docs
This commit is contained in:
parent
83e2479699
commit
192b9160a7
10 changed files with 68 additions and 24 deletions
|
|
@ -1 +1,2 @@
|
||||||
^data-raw$
|
^data-raw$
|
||||||
|
^libs$
|
||||||
|
|
|
||||||
|
|
@ -30,12 +30,13 @@ Imports:
|
||||||
Suggests:
|
Suggests:
|
||||||
knitr,
|
knitr,
|
||||||
testthat,
|
testthat,
|
||||||
readr
|
readr,
|
||||||
|
rmarkdown
|
||||||
License: MIT + file LICENSE
|
License: MIT + file LICENSE
|
||||||
URL: https://github.com/facebook/prophet
|
URL: https://github.com/facebook/prophet
|
||||||
BugReports: https://github.com/facebook/prophet/issues
|
BugReports: https://github.com/facebook/prophet/issues
|
||||||
LazyData: true
|
LazyData: true
|
||||||
RoxygenNote: 6.1.1
|
RoxygenNote: 7.0.2
|
||||||
VignetteBuilder: knitr
|
VignetteBuilder: knitr
|
||||||
SystemRequirements: C++11
|
SystemRequirements: C++11
|
||||||
Encoding: UTF-8
|
Encoding: UTF-8
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,14 @@
|
||||||
\alias{add_changepoints_to_plot}
|
\alias{add_changepoints_to_plot}
|
||||||
\title{Get layers to overlay significant changepoints on prophet forecast plot.}
|
\title{Get layers to overlay significant changepoints on prophet forecast plot.}
|
||||||
\usage{
|
\usage{
|
||||||
add_changepoints_to_plot(m, threshold = 0.01, cp_color = "red",
|
add_changepoints_to_plot(
|
||||||
cp_linetype = "dashed", trend = TRUE, ...)
|
m,
|
||||||
|
threshold = 0.01,
|
||||||
|
cp_color = "red",
|
||||||
|
cp_linetype = "dashed",
|
||||||
|
trend = TRUE,
|
||||||
|
...
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model object.}
|
\item{m}{Prophet model object.}
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,7 @@
|
||||||
\alias{add_regressor}
|
\alias{add_regressor}
|
||||||
\title{Add an additional regressor to be used for fitting and predicting.}
|
\title{Add an additional regressor to be used for fitting and predicting.}
|
||||||
\usage{
|
\usage{
|
||||||
add_regressor(m, name, prior.scale = NULL, standardize = "auto",
|
add_regressor(m, name, prior.scale = NULL, standardize = "auto", mode = NULL)
|
||||||
mode = NULL)
|
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet object.}
|
\item{m}{Prophet object.}
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,15 @@
|
||||||
\title{Add a seasonal component with specified period, number of Fourier
|
\title{Add a seasonal component with specified period, number of Fourier
|
||||||
components, and prior scale.}
|
components, and prior scale.}
|
||||||
\usage{
|
\usage{
|
||||||
add_seasonality(m, name, period, fourier.order, prior.scale = NULL,
|
add_seasonality(
|
||||||
mode = NULL, condition.name = NULL)
|
m,
|
||||||
|
name,
|
||||||
|
period,
|
||||||
|
fourier.order,
|
||||||
|
prior.scale = NULL,
|
||||||
|
mode = NULL,
|
||||||
|
condition.name = NULL
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet object.}
|
\item{m}{Prophet object.}
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,15 @@
|
||||||
\alias{plot.prophet}
|
\alias{plot.prophet}
|
||||||
\title{Plot the prophet forecast.}
|
\title{Plot the prophet forecast.}
|
||||||
\usage{
|
\usage{
|
||||||
\method{plot}{prophet}(x, fcst, uncertainty = TRUE, plot_cap = TRUE,
|
\method{plot}{prophet}(
|
||||||
xlabel = "ds", ylabel = "y", ...)
|
x,
|
||||||
|
fcst,
|
||||||
|
uncertainty = TRUE,
|
||||||
|
plot_cap = TRUE,
|
||||||
|
xlabel = "ds",
|
||||||
|
ylabel = "y",
|
||||||
|
...
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{x}{Prophet object.}
|
\item{x}{Prophet object.}
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,7 @@
|
||||||
\alias{plot_forecast_component}
|
\alias{plot_forecast_component}
|
||||||
\title{Plot a particular component of the forecast.}
|
\title{Plot a particular component of the forecast.}
|
||||||
\usage{
|
\usage{
|
||||||
plot_forecast_component(m, fcst, name, uncertainty = TRUE,
|
plot_forecast_component(m, fcst, name, uncertainty = TRUE, plot_cap = FALSE)
|
||||||
plot_cap = FALSE)
|
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model}
|
\item{m}{Prophet model}
|
||||||
|
|
|
||||||
|
|
@ -4,14 +4,26 @@
|
||||||
\alias{prophet}
|
\alias{prophet}
|
||||||
\title{Prophet forecaster.}
|
\title{Prophet forecaster.}
|
||||||
\usage{
|
\usage{
|
||||||
prophet(df = NULL, growth = "linear", changepoints = NULL,
|
prophet(
|
||||||
n.changepoints = 25, changepoint.range = 0.8,
|
df = NULL,
|
||||||
yearly.seasonality = "auto", weekly.seasonality = "auto",
|
growth = "linear",
|
||||||
daily.seasonality = "auto", holidays = NULL,
|
changepoints = NULL,
|
||||||
seasonality.mode = "additive", seasonality.prior.scale = 10,
|
n.changepoints = 25,
|
||||||
holidays.prior.scale = 10, changepoint.prior.scale = 0.05,
|
changepoint.range = 0.8,
|
||||||
mcmc.samples = 0, interval.width = 0.8, uncertainty.samples = 1000,
|
yearly.seasonality = "auto",
|
||||||
fit = TRUE, ...)
|
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{
|
\arguments{
|
||||||
\item{df}{(optional) Dataframe containing the history. Must have columns ds
|
\item{df}{(optional) Dataframe containing the history. Must have columns ds
|
||||||
|
|
|
||||||
|
|
@ -7,8 +7,15 @@ Prints a ggplot2 with whichever are available of: trend, holidays, weekly
|
||||||
seasonality, yearly seasonality, and additive and multiplicative extra
|
seasonality, yearly seasonality, and additive and multiplicative extra
|
||||||
regressors.}
|
regressors.}
|
||||||
\usage{
|
\usage{
|
||||||
prophet_plot_components(m, fcst, uncertainty = TRUE, plot_cap = TRUE,
|
prophet_plot_components(
|
||||||
weekly_start = 0, yearly_start = 0, render_plot = TRUE)
|
m,
|
||||||
|
fcst,
|
||||||
|
uncertainty = TRUE,
|
||||||
|
plot_cap = TRUE,
|
||||||
|
weekly_start = 0,
|
||||||
|
yearly_start = 0,
|
||||||
|
render_plot = TRUE
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet object.}
|
\item{m}{Prophet object.}
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,13 @@
|
||||||
\alias{validate_column_name}
|
\alias{validate_column_name}
|
||||||
\title{Validates the name of a seasonality, holiday, or regressor.}
|
\title{Validates the name of a seasonality, holiday, or regressor.}
|
||||||
\usage{
|
\usage{
|
||||||
validate_column_name(m, name, check_holidays = TRUE,
|
validate_column_name(
|
||||||
check_seasonalities = TRUE, check_regressors = TRUE)
|
m,
|
||||||
|
name,
|
||||||
|
check_holidays = TRUE,
|
||||||
|
check_seasonalities = TRUE,
|
||||||
|
check_regressors = TRUE
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet object.}
|
\item{m}{Prophet object.}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue