From bb242ea180e44b3aa05c4da17644a59aa7cce437 Mon Sep 17 00:00:00 2001 From: Ben Letham Date: Sun, 9 Feb 2020 19:31:44 -0800 Subject: [PATCH] R documentation updates --- R/man/dyplot.prophet.Rd | 7 ++++--- R/man/plot.prophet.Rd | 5 +++-- R/man/plot_forecast_component.Rd | 3 ++- R/man/plot_seasonality.Rd | 3 ++- R/man/plot_weekly.Rd | 5 +++-- R/man/plot_yearly.Rd | 5 +++-- R/man/prophet.Rd | 3 ++- R/man/prophet_plot_components.Rd | 5 +++-- 8 files changed, 22 insertions(+), 14 deletions(-) diff --git a/R/man/dyplot.prophet.Rd b/R/man/dyplot.prophet.Rd index c3ec4f0..86d4a8d 100644 --- a/R/man/dyplot.prophet.Rd +++ b/R/man/dyplot.prophet.Rd @@ -11,10 +11,11 @@ dyplot.prophet(x, fcst, uncertainty = TRUE, ...) \item{fcst}{Data frame returned by predict(m, df).} -\item{uncertainty}{Boolean indicating if the uncertainty interval for yhat -should be plotted. Must be present in fcst as yhat_lower and yhat_upper.} +\item{uncertainty}{Optional boolean indicating if the uncertainty interval for yhat +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{ A dygraph plot. diff --git a/R/man/plot.prophet.Rd b/R/man/plot.prophet.Rd index 38cd604..f20f2f7 100644 --- a/R/man/plot.prophet.Rd +++ b/R/man/plot.prophet.Rd @@ -12,8 +12,9 @@ \item{fcst}{Data frame returned by predict(m, df).} -\item{uncertainty}{Boolean indicating if the uncertainty interval for yhat -should be plotted. Must be present in fcst as yhat_lower and yhat_upper.} +\item{uncertainty}{Optional boolean indicating if the uncertainty interval for yhat +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 figure, if available.} diff --git a/R/man/plot_forecast_component.Rd b/R/man/plot_forecast_component.Rd index 13e4dd8..f4e18d1 100644 --- a/R/man/plot_forecast_component.Rd +++ b/R/man/plot_forecast_component.Rd @@ -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{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 figure, if available.} diff --git a/R/man/plot_seasonality.Rd b/R/man/plot_seasonality.Rd index e5f2df4..53f64c2 100644 --- a/R/man/plot_seasonality.Rd +++ b/R/man/plot_seasonality.Rd @@ -11,7 +11,8 @@ plot_seasonality(m, name, uncertainty = TRUE) \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{ A ggplot2 plot. diff --git a/R/man/plot_weekly.Rd b/R/man/plot_weekly.Rd index d0f5a1e..067b3be 100644 --- a/R/man/plot_weekly.Rd +++ b/R/man/plot_weekly.Rd @@ -9,13 +9,14 @@ plot_weekly(m, uncertainty = TRUE, weekly_start = 0, name = "weekly") \arguments{ \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 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 +\item{name}{Name of seasonality component if previously changed from default 'weekly'.} } \value{ diff --git a/R/man/plot_yearly.Rd b/R/man/plot_yearly.Rd index 771080e..429ee34 100644 --- a/R/man/plot_yearly.Rd +++ b/R/man/plot_yearly.Rd @@ -9,13 +9,14 @@ plot_yearly(m, uncertainty = TRUE, yearly_start = 0, name = "yearly") \arguments{ \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 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 +\item{name}{Name of seasonality component if previously changed from default 'yearly'.} } \value{ diff --git a/R/man/prophet.Rd b/R/man/prophet.Rd index 15807a7..bf6ea22 100644 --- a/R/man/prophet.Rd +++ b/R/man/prophet.Rd @@ -76,7 +76,8 @@ If mcmc.samples>0, this will be integrated over all model parameters, which will include uncertainty in seasonality.} \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.} diff --git a/R/man/prophet_plot_components.Rd b/R/man/prophet_plot_components.Rd index f46afb8..d954761 100644 --- a/R/man/prophet_plot_components.Rd +++ b/R/man/prophet_plot_components.Rd @@ -15,8 +15,9 @@ prophet_plot_components(m, fcst, uncertainty = TRUE, plot_cap = TRUE, \item{fcst}{Data frame returned by predict(m, df).} -\item{uncertainty}{Boolean indicating if the uncertainty interval should be -plotted for the trend, from fcst columns trend_lower and trend_upper.} +\item{uncertainty}{Optional boolean indicating if the uncertainty interval should be +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 figure, if available.}