From 23b59d7eaa526c761b971891940080e7c5ca786a Mon Sep 17 00:00:00 2001
From: mitchelloharawild <mitch.ohara-wild@monash.edu>
Date: Thu, 23 Mar 2023 00:57:52 +1100
Subject: [PATCH] Add new_data param docs

---
 R/arima.R                     | 1 +
 man/forecast.AR.Rd            | 2 ++
 man/forecast.ARIMA.Rd         | 2 ++
 man/forecast.ETS.Rd           | 2 ++
 man/forecast.NNETAR.Rd        | 2 ++
 man/forecast.RW.Rd            | 2 ++
 man/forecast.TSLM.Rd          | 2 ++
 man/forecast.VAR.Rd           | 2 ++
 man/forecast.croston.Rd       | 2 ++
 man/forecast.fable_theta.Rd   | 2 ++
 man/forecast.model_mean.Rd    | 2 ++
 man/generate.AR.Rd            | 2 ++
 man/generate.ARIMA.Rd         | 2 ++
 man/generate.ETS.Rd           | 2 ++
 man/generate.NNETAR.Rd        | 2 ++
 man/generate.RW.Rd            | 2 ++
 man/generate.TSLM.Rd          | 2 ++
 man/generate.model_mean.Rd    | 2 ++
 man/interpolate.ARIMA.Rd      | 2 ++
 man/interpolate.TSLM.Rd       | 2 ++
 man/interpolate.model_mean.Rd | 2 ++
 man/refit.AR.Rd               | 2 ++
 man/refit.ARIMA.Rd            | 2 ++
 man/refit.ETS.Rd              | 2 ++
 man/refit.NNETAR.Rd           | 2 ++
 man/refit.RW.Rd               | 2 ++
 man/refit.TSLM.Rd             | 2 ++
 man/refit.model_mean.Rd       | 2 ++
 28 files changed, 55 insertions(+)

diff --git a/R/arima.R b/R/arima.R
index 1b36ffda..d00054d3 100644
--- a/R/arima.R
+++ b/R/arima.R
@@ -773,6 +773,7 @@ report.ARIMA <- function(object, ...) {
 #' Produces forecasts from a trained model.
 #'
 #' @inheritParams generics::forecast
+#' @param new_data A tsibble containing the time points and exogenous regressors to produce forecasts for.
 #' @param specials (passed by [`fabletools::forecast.mdl_df()`]).
 #' @param bootstrap If `TRUE`, then forecast distributions are computed using simulation with resampled errors.
 #' @param times The number of sample paths to use in estimating the forecast distribution when `bootstrap = TRUE`.
diff --git a/man/forecast.AR.Rd b/man/forecast.AR.Rd
index 872e4b81..a0fc43fd 100644
--- a/man/forecast.AR.Rd
+++ b/man/forecast.AR.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/forecast.ARIMA.Rd b/man/forecast.ARIMA.Rd
index 4038f5de..ef7c4535 100644
--- a/man/forecast.ARIMA.Rd
+++ b/man/forecast.ARIMA.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/forecast.ETS.Rd b/man/forecast.ETS.Rd
index 5979cb32..bea56e87 100644
--- a/man/forecast.ETS.Rd
+++ b/man/forecast.ETS.Rd
@@ -17,6 +17,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{simulate}{If \code{TRUE}, prediction intervals are produced by simulation rather than using analytic formulae.}
diff --git a/man/forecast.NNETAR.Rd b/man/forecast.NNETAR.Rd
index d41fbc33..472596af 100644
--- a/man/forecast.NNETAR.Rd
+++ b/man/forecast.NNETAR.Rd
@@ -17,6 +17,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{simulate}{If \code{TRUE}, prediction intervals are produced by simulation rather than using analytic formulae.}
diff --git a/man/forecast.RW.Rd b/man/forecast.RW.Rd
index 24cef4d8..4ecf7638 100644
--- a/man/forecast.RW.Rd
+++ b/man/forecast.RW.Rd
@@ -17,6 +17,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{simulate}{If \code{TRUE}, prediction intervals are produced by simulation rather than using analytic formulae.}
diff --git a/man/forecast.TSLM.Rd b/man/forecast.TSLM.Rd
index 00645e83..c6c64fdb 100644
--- a/man/forecast.TSLM.Rd
+++ b/man/forecast.TSLM.Rd
@@ -17,6 +17,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/forecast.VAR.Rd b/man/forecast.VAR.Rd
index 9d500c2b..b8bad397 100644
--- a/man/forecast.VAR.Rd
+++ b/man/forecast.VAR.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/forecast.croston.Rd b/man/forecast.croston.Rd
index 08c97b61..bf0b97ec 100644
--- a/man/forecast.croston.Rd
+++ b/man/forecast.croston.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/forecast.fable_theta.Rd b/man/forecast.fable_theta.Rd
index af016b04..f4e0c082 100644
--- a/man/forecast.fable_theta.Rd
+++ b/man/forecast.fable_theta.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/forecast.model_mean.Rd b/man/forecast.model_mean.Rd
index 58eae2f5..a6f491b1 100644
--- a/man/forecast.model_mean.Rd
+++ b/man/forecast.model_mean.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.AR.Rd b/man/generate.AR.Rd
index 072cb2d3..b0be5553 100644
--- a/man/generate.AR.Rd
+++ b/man/generate.AR.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.ARIMA.Rd b/man/generate.ARIMA.Rd
index fcaee4cb..ecdbda2f 100644
--- a/man/generate.ARIMA.Rd
+++ b/man/generate.ARIMA.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.ETS.Rd b/man/generate.ETS.Rd
index 7c26b208..c8362da7 100644
--- a/man/generate.ETS.Rd
+++ b/man/generate.ETS.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.NNETAR.Rd b/man/generate.NNETAR.Rd
index 31875553..2bf581c9 100644
--- a/man/generate.NNETAR.Rd
+++ b/man/generate.NNETAR.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.RW.Rd b/man/generate.RW.Rd
index fd6ea38b..dafc6bf8 100644
--- a/man/generate.RW.Rd
+++ b/man/generate.RW.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/generate.TSLM.Rd b/man/generate.TSLM.Rd
index 6194c3fb..ab5c9219 100644
--- a/man/generate.TSLM.Rd
+++ b/man/generate.TSLM.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
diff --git a/man/generate.model_mean.Rd b/man/generate.model_mean.Rd
index 35a54d04..887ee307 100644
--- a/man/generate.model_mean.Rd
+++ b/man/generate.model_mean.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{x}{A fitted model.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/interpolate.ARIMA.Rd b/man/interpolate.ARIMA.Rd
index 3e55f00d..ed1ea918 100644
--- a/man/interpolate.ARIMA.Rd
+++ b/man/interpolate.ARIMA.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/interpolate.TSLM.Rd b/man/interpolate.TSLM.Rd
index 08adb432..d4ac1c38 100644
--- a/man/interpolate.TSLM.Rd
+++ b/man/interpolate.TSLM.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/interpolate.model_mean.Rd b/man/interpolate.model_mean.Rd
index 624b3f88..1ea38394 100644
--- a/man/interpolate.model_mean.Rd
+++ b/man/interpolate.model_mean.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{...}{Other arguments passed to methods}
diff --git a/man/refit.AR.Rd b/man/refit.AR.Rd
index f0293a81..05a732e8 100644
--- a/man/refit.AR.Rd
+++ b/man/refit.AR.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the coefficients for the fitted model will be re-estimated to suit the new data.}
diff --git a/man/refit.ARIMA.Rd b/man/refit.ARIMA.Rd
index 70702a5e..66d59449 100644
--- a/man/refit.ARIMA.Rd
+++ b/man/refit.ARIMA.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the coefficients for the fitted model will be re-estimated to suit the new data.}
diff --git a/man/refit.ETS.Rd b/man/refit.ETS.Rd
index f2e518ee..fadad569 100644
--- a/man/refit.ETS.Rd
+++ b/man/refit.ETS.Rd
@@ -16,6 +16,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the coefficients for the fitted model will be re-estimated to suit the new data.}
diff --git a/man/refit.NNETAR.Rd b/man/refit.NNETAR.Rd
index 2108cf22..b667104c 100644
--- a/man/refit.NNETAR.Rd
+++ b/man/refit.NNETAR.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the networks will be initialized with random
diff --git a/man/refit.RW.Rd b/man/refit.RW.Rd
index ba147ec9..8097977c 100644
--- a/man/refit.RW.Rd
+++ b/man/refit.RW.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the lag walk model will be re-estimated
diff --git a/man/refit.TSLM.Rd b/man/refit.TSLM.Rd
index 832f9981..3cc239fe 100644
--- a/man/refit.TSLM.Rd
+++ b/man/refit.TSLM.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the coefficients for the fitted model will be re-estimated to suit the new data.}
diff --git a/man/refit.model_mean.Rd b/man/refit.model_mean.Rd
index fd26bbd2..f97f2550 100644
--- a/man/refit.model_mean.Rd
+++ b/man/refit.model_mean.Rd
@@ -9,6 +9,8 @@
 \arguments{
 \item{object}{A model for which forecasts are required.}
 
+\item{new_data}{A tsibble containing the time points and exogenous regressors to produce forecasts for.}
+
 \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).}
 
 \item{reestimate}{If \code{TRUE}, the mean for the fitted model will be re-estimated