mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-18 08:53:42 +00:00
R documentation updates
This commit is contained in:
parent
9413c1141e
commit
bb242ea180
8 changed files with 22 additions and 14 deletions
|
|
@ -11,10 +11,11 @@ dyplot.prophet(x, fcst, uncertainty = TRUE, ...)
|
||||||
|
|
||||||
\item{fcst}{Data frame returned by predict(m, df).}
|
\item{fcst}{Data frame returned by predict(m, df).}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean indicating if the uncertainty interval for yhat
|
\item{uncertainty}{Optional boolean indicating if the uncertainty interval for yhat
|
||||||
should be plotted. Must be present in fcst as yhat_lower and yhat_upper.}
|
should be plotted, which will only be done if x$uncertainty.samples > 0. Must be
|
||||||
|
present in fcst as yhat_lower and yhat_upper.}
|
||||||
|
|
||||||
\item{...}{additional arguments}
|
\item{...}{additional arguments passed to dygraph::dygraph}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A dygraph plot.
|
A dygraph plot.
|
||||||
|
|
|
||||||
|
|
@ -12,8 +12,9 @@
|
||||||
|
|
||||||
\item{fcst}{Data frame returned by predict(m, df).}
|
\item{fcst}{Data frame returned by predict(m, df).}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean indicating if the uncertainty interval for yhat
|
\item{uncertainty}{Optional boolean indicating if the uncertainty interval for yhat
|
||||||
should be plotted. Must be present in fcst as yhat_lower and yhat_upper.}
|
should be plotted, which will only be done if x$uncertainty.samples > 0.
|
||||||
|
Must be present in fcst as yhat_lower and yhat_upper.}
|
||||||
|
|
||||||
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
||||||
figure, if available.}
|
figure, if available.}
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,8 @@ plot_forecast_component(m, fcst, name, uncertainty = TRUE,
|
||||||
|
|
||||||
\item{name}{String name of the component to plot (column of fcst).}
|
\item{name}{String name of the component to plot (column of fcst).}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean to plot uncertainty intervals.}
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which will
|
||||||
|
only be done if m$uncertainty.samples > 0.}
|
||||||
|
|
||||||
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
||||||
figure, if available.}
|
figure, if available.}
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,8 @@ plot_seasonality(m, name, uncertainty = TRUE)
|
||||||
|
|
||||||
\item{name}{String name of the seasonality.}
|
\item{name}{String name of the seasonality.}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean to plot uncertainty intervals.}
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which
|
||||||
|
will only be done if m$uncertainty.samples > 0.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A ggplot2 plot.
|
A ggplot2 plot.
|
||||||
|
|
|
||||||
|
|
@ -9,13 +9,14 @@ plot_weekly(m, uncertainty = TRUE, weekly_start = 0, name = "weekly")
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model object}
|
\item{m}{Prophet model object}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean to plot uncertainty intervals.}
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which will
|
||||||
|
only be done if m$uncertainty.samples > 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
|
\item{name}{Name of seasonality component if previously changed
|
||||||
from default 'weekly'.}
|
from default 'weekly'.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
|
|
|
||||||
|
|
@ -9,13 +9,14 @@ plot_yearly(m, uncertainty = TRUE, yearly_start = 0, name = "yearly")
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{m}{Prophet model object.}
|
\item{m}{Prophet model object.}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean to plot uncertainty intervals.}
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which
|
||||||
|
will only be done if m$uncertainty.samples > 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
|
\item{name}{Name of seasonality component if previously changed
|
||||||
from default 'yearly'.}
|
from default 'yearly'.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
|
|
|
||||||
|
|
@ -76,7 +76,8 @@ If mcmc.samples>0, this will be integrated over all model parameters,
|
||||||
which will include uncertainty in seasonality.}
|
which will include uncertainty in seasonality.}
|
||||||
|
|
||||||
\item{uncertainty.samples}{Number of simulated draws used to estimate
|
\item{uncertainty.samples}{Number of simulated draws used to estimate
|
||||||
uncertainty intervals.}
|
uncertainty intervals. Settings this value to 0 or False will disable
|
||||||
|
uncertainty estimation and speed up the calculation.}
|
||||||
|
|
||||||
\item{fit}{Boolean, if FALSE the model is initialized but not fit.}
|
\item{fit}{Boolean, if FALSE the model is initialized but not fit.}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -15,8 +15,9 @@ prophet_plot_components(m, fcst, uncertainty = TRUE, plot_cap = TRUE,
|
||||||
|
|
||||||
\item{fcst}{Data frame returned by predict(m, df).}
|
\item{fcst}{Data frame returned by predict(m, df).}
|
||||||
|
|
||||||
\item{uncertainty}{Boolean indicating if the uncertainty interval should be
|
\item{uncertainty}{Optional boolean indicating if the uncertainty interval should be
|
||||||
plotted for the trend, from fcst columns trend_lower and trend_upper.}
|
plotted for the trend, from fcst columns trend_lower and trend_upper.This will
|
||||||
|
only be done if m$uncertainty.samples > 0.}
|
||||||
|
|
||||||
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
||||||
figure, if available.}
|
figure, if available.}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue