From a3824a32d247b04e862b93bc3b846ae626f72bbd Mon Sep 17 00:00:00 2001 From: mitchelloharawild Date: Wed, 22 Mar 2023 02:24:38 +1100 Subject: [PATCH] Update docs --- R/arima.R | 2 +- man/fitted.AR.Rd | 4 ++-- man/fitted.ARIMA.Rd | 4 ++-- man/fitted.ETS.Rd | 4 ++-- man/fitted.NNETAR.Rd | 4 ++-- man/fitted.RW.Rd | 4 ++-- man/fitted.TSLM.Rd | 4 ++-- man/fitted.VAR.Rd | 4 ++-- man/fitted.croston.Rd | 4 ++-- man/fitted.fable_theta.Rd | 4 ++-- man/fitted.model_mean.Rd | 4 ++-- man/forecast.AR.Rd | 6 ++---- man/forecast.ARIMA.Rd | 6 ++---- man/forecast.ETS.Rd | 6 ++---- man/forecast.NNETAR.Rd | 6 ++---- man/forecast.RW.Rd | 6 ++---- man/forecast.TSLM.Rd | 6 ++---- man/forecast.VAR.Rd | 6 ++---- man/forecast.croston.Rd | 6 ++---- man/forecast.fable_theta.Rd | 6 ++---- man/forecast.model_mean.Rd | 6 ++---- man/generate.AR.Rd | 4 +--- man/generate.ARIMA.Rd | 4 +--- man/generate.ETS.Rd | 4 +--- man/generate.NNETAR.Rd | 4 +--- man/generate.RW.Rd | 4 +--- man/generate.TSLM.Rd | 4 +--- man/generate.model_mean.Rd | 4 +--- man/interpolate.ARIMA.Rd | 6 ++---- man/interpolate.TSLM.Rd | 6 ++---- man/interpolate.model_mean.Rd | 6 ++---- man/refit.AR.Rd | 6 ++---- man/refit.ARIMA.Rd | 6 ++---- man/refit.ETS.Rd | 6 ++---- man/refit.NNETAR.Rd | 6 ++---- man/refit.RW.Rd | 6 ++---- man/refit.TSLM.Rd | 6 ++---- man/refit.model_mean.Rd | 6 ++---- man/residuals.AR.Rd | 4 ++-- man/residuals.ARIMA.Rd | 4 ++-- man/residuals.ETS.Rd | 4 ++-- man/residuals.NNETAR.Rd | 4 ++-- man/residuals.RW.Rd | 4 ++-- man/residuals.TSLM.Rd | 4 ++-- man/residuals.VAR.Rd | 4 ++-- man/residuals.croston.Rd | 4 ++-- man/residuals.fable_theta.Rd | 4 ++-- man/residuals.model_mean.Rd | 4 ++-- 48 files changed, 88 insertions(+), 142 deletions(-) diff --git a/R/arima.R b/R/arima.R index e2e2803b..1b36ffda 100644 --- a/R/arima.R +++ b/R/arima.R @@ -772,7 +772,7 @@ report.ARIMA <- function(object, ...) { #' #' Produces forecasts from a trained model. #' -#' @inheritParams fabletools::forecast +#' @inheritParams generics::forecast #' @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/fitted.AR.Rd b/man/fitted.AR.Rd index a923a184..8b9525e8 100644 --- a/man/fitted.AR.Rd +++ b/man/fitted.AR.Rd @@ -7,9 +7,9 @@ \method{fitted}{AR}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.ARIMA.Rd b/man/fitted.ARIMA.Rd index 73e3baf8..622c5e49 100644 --- a/man/fitted.ARIMA.Rd +++ b/man/fitted.ARIMA.Rd @@ -7,9 +7,9 @@ \method{fitted}{ARIMA}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.ETS.Rd b/man/fitted.ETS.Rd index 30ef2589..beefc6af 100644 --- a/man/fitted.ETS.Rd +++ b/man/fitted.ETS.Rd @@ -7,9 +7,9 @@ \method{fitted}{ETS}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.NNETAR.Rd b/man/fitted.NNETAR.Rd index 77b50242..cbae4e65 100644 --- a/man/fitted.NNETAR.Rd +++ b/man/fitted.NNETAR.Rd @@ -7,9 +7,9 @@ \method{fitted}{NNETAR}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.RW.Rd b/man/fitted.RW.Rd index 9ac64b46..29852bfb 100644 --- a/man/fitted.RW.Rd +++ b/man/fitted.RW.Rd @@ -7,9 +7,9 @@ \method{fitted}{RW}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.TSLM.Rd b/man/fitted.TSLM.Rd index 0c040085..29c6c4a8 100644 --- a/man/fitted.TSLM.Rd +++ b/man/fitted.TSLM.Rd @@ -7,9 +7,9 @@ \method{fitted}{TSLM}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.VAR.Rd b/man/fitted.VAR.Rd index ee5bbeb1..6b0959dd 100644 --- a/man/fitted.VAR.Rd +++ b/man/fitted.VAR.Rd @@ -7,9 +7,9 @@ \method{fitted}{VAR}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.croston.Rd b/man/fitted.croston.Rd index 1619b0d2..7b222646 100644 --- a/man/fitted.croston.Rd +++ b/man/fitted.croston.Rd @@ -7,9 +7,9 @@ \method{fitted}{croston}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.fable_theta.Rd b/man/fitted.fable_theta.Rd index bf648564..ca393a92 100644 --- a/man/fitted.fable_theta.Rd +++ b/man/fitted.fable_theta.Rd @@ -7,9 +7,9 @@ \method{fitted}{fable_theta}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/fitted.model_mean.Rd b/man/fitted.model_mean.Rd index 53616247..2e944029 100644 --- a/man/fitted.model_mean.Rd +++ b/man/fitted.model_mean.Rd @@ -7,9 +7,9 @@ \method{fitted}{model_mean}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted values. diff --git a/man/forecast.AR.Rd b/man/forecast.AR.Rd index 6ce55e4c..872e4b81 100644 --- a/man/forecast.AR.Rd +++ b/man/forecast.AR.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.ARIMA.Rd b/man/forecast.ARIMA.Rd index e4397aef..4038f5de 100644 --- a/man/forecast.ARIMA.Rd +++ b/man/forecast.ARIMA.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.ETS.Rd b/man/forecast.ETS.Rd index 75928f46..5979cb32 100644 --- a/man/forecast.ETS.Rd +++ b/man/forecast.ETS.Rd @@ -15,9 +15,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -27,7 +25,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution if simulated intervals are used.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.NNETAR.Rd b/man/forecast.NNETAR.Rd index d439f6f9..d41fbc33 100644 --- a/man/forecast.NNETAR.Rd +++ b/man/forecast.NNETAR.Rd @@ -15,9 +15,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -27,7 +25,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution if simulated intervals are used.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.RW.Rd b/man/forecast.RW.Rd index 81c4944a..24cef4d8 100644 --- a/man/forecast.RW.Rd +++ b/man/forecast.RW.Rd @@ -15,9 +15,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -27,7 +25,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.TSLM.Rd b/man/forecast.TSLM.Rd index 673472de..00645e83 100644 --- a/man/forecast.TSLM.Rd +++ b/man/forecast.TSLM.Rd @@ -15,9 +15,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -31,7 +29,7 @@ or reconciliation processes.} \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.VAR.Rd b/man/forecast.VAR.Rd index 0d1e8cab..9d500c2b 100644 --- a/man/forecast.VAR.Rd +++ b/man/forecast.VAR.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.croston.Rd b/man/forecast.croston.Rd index 6a644ebc..08c97b61 100644 --- a/man/forecast.croston.Rd +++ b/man/forecast.croston.Rd @@ -7,13 +7,11 @@ \method{forecast}{croston}(object, new_data, specials = NULL, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.fable_theta.Rd b/man/forecast.fable_theta.Rd index de294699..af016b04 100644 --- a/man/forecast.fable_theta.Rd +++ b/man/forecast.fable_theta.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/forecast.model_mean.Rd b/man/forecast.model_mean.Rd index 45010b84..58eae2f5 100644 --- a/man/forecast.model_mean.Rd +++ b/man/forecast.model_mean.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{times}{The number of sample paths to use in estimating the forecast distribution when \code{bootstrap = TRUE}.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A list of forecasts. diff --git a/man/generate.AR.Rd b/man/generate.AR.Rd index 3cfa7b94..072cb2d3 100644 --- a/man/generate.AR.Rd +++ b/man/generate.AR.Rd @@ -9,13 +9,11 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.ARIMA.Rd b/man/generate.ARIMA.Rd index 79c16dcd..fcaee4cb 100644 --- a/man/generate.ARIMA.Rd +++ b/man/generate.ARIMA.Rd @@ -9,13 +9,11 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.ETS.Rd b/man/generate.ETS.Rd index b5e8f131..7c26b208 100644 --- a/man/generate.ETS.Rd +++ b/man/generate.ETS.Rd @@ -9,13 +9,11 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.NNETAR.Rd b/man/generate.NNETAR.Rd index a942a655..31875553 100644 --- a/man/generate.NNETAR.Rd +++ b/man/generate.NNETAR.Rd @@ -9,13 +9,11 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.RW.Rd b/man/generate.RW.Rd index 0859f351..fd6ea38b 100644 --- a/man/generate.RW.Rd +++ b/man/generate.RW.Rd @@ -9,11 +9,9 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.TSLM.Rd b/man/generate.TSLM.Rd index 327bc5df..6194c3fb 100644 --- a/man/generate.TSLM.Rd +++ b/man/generate.TSLM.Rd @@ -9,13 +9,11 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/generate.model_mean.Rd b/man/generate.model_mean.Rd index 87239007..35a54d04 100644 --- a/man/generate.model_mean.Rd +++ b/man/generate.model_mean.Rd @@ -9,11 +9,9 @@ \arguments{ \item{x}{A fitted model.} -\item{new_data}{A \code{tsibble} containing future information used to forecast.} - \item{bootstrap}{If \code{TRUE}, then forecast distributions are computed using simulation with resampled errors.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Simulates future paths from a dataset using a fitted model. Innovations are diff --git a/man/interpolate.ARIMA.Rd b/man/interpolate.ARIMA.Rd index 9d3aac3e..3e55f00d 100644 --- a/man/interpolate.ARIMA.Rd +++ b/man/interpolate.ARIMA.Rd @@ -7,13 +7,11 @@ \method{interpolate}{ARIMA}(object, new_data, specials, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A tibble of the same dimension of \code{new_data} with missing values interpolated. diff --git a/man/interpolate.TSLM.Rd b/man/interpolate.TSLM.Rd index 18bee625..08adb432 100644 --- a/man/interpolate.TSLM.Rd +++ b/man/interpolate.TSLM.Rd @@ -7,13 +7,11 @@ \method{interpolate}{TSLM}(object, new_data, specials, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A tibble of the same dimension of \code{new_data} with missing values interpolated. diff --git a/man/interpolate.model_mean.Rd b/man/interpolate.model_mean.Rd index cc772645..624b3f88 100644 --- a/man/interpolate.model_mean.Rd +++ b/man/interpolate.model_mean.Rd @@ -7,13 +7,11 @@ \method{interpolate}{model_mean}(object, new_data, specials, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A tibble of the same dimension of \code{new_data} with missing values interpolated. diff --git a/man/refit.AR.Rd b/man/refit.AR.Rd index 626fa1d2..f0293a81 100644 --- a/man/refit.AR.Rd +++ b/man/refit.AR.Rd @@ -7,15 +7,13 @@ \method{refit}{AR}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A refitted model. diff --git a/man/refit.ARIMA.Rd b/man/refit.ARIMA.Rd index db9a94f8..70702a5e 100644 --- a/man/refit.ARIMA.Rd +++ b/man/refit.ARIMA.Rd @@ -7,15 +7,13 @@ \method{refit}{ARIMA}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A refitted model. diff --git a/man/refit.ETS.Rd b/man/refit.ETS.Rd index 6de85835..f2e518ee 100644 --- a/man/refit.ETS.Rd +++ b/man/refit.ETS.Rd @@ -14,9 +14,7 @@ ) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -24,7 +22,7 @@ \item{reinitialise}{If TRUE, the initial parameters will be re-estimated to suit the new data.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Applies a fitted ETS model to a new dataset. diff --git a/man/refit.NNETAR.Rd b/man/refit.NNETAR.Rd index 6648f5c3..2108cf22 100644 --- a/man/refit.NNETAR.Rd +++ b/man/refit.NNETAR.Rd @@ -7,9 +7,7 @@ \method{refit}{NNETAR}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \item{specials}{(passed by \code{\link[fabletools:forecast]{fabletools::forecast.mdl_df()}}).} @@ -18,7 +16,7 @@ starting weights to suit the new data. If \code{FALSE}, for every network the be individual set of weights found in the pre-estimation process is used as the starting weight vector.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A refitted model. diff --git a/man/refit.RW.Rd b/man/refit.RW.Rd index e41d4417..ba147ec9 100644 --- a/man/refit.RW.Rd +++ b/man/refit.RW.Rd @@ -7,16 +7,14 @@ \method{refit}{RW}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \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 to suit the new data.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Applies a fitted random walk model to a new dataset. diff --git a/man/refit.TSLM.Rd b/man/refit.TSLM.Rd index e331a7b7..832f9981 100644 --- a/man/refit.TSLM.Rd +++ b/man/refit.TSLM.Rd @@ -7,15 +7,13 @@ \method{refit}{TSLM}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \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.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Applies a fitted \code{TSLM} to a new dataset. diff --git a/man/refit.model_mean.Rd b/man/refit.model_mean.Rd index 0cb987c3..fd26bbd2 100644 --- a/man/refit.model_mean.Rd +++ b/man/refit.model_mean.Rd @@ -7,16 +7,14 @@ \method{refit}{model_mean}(object, new_data, specials = NULL, reestimate = FALSE, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} - -\item{new_data}{A \code{tsibble} containing future information used to forecast.} +\item{object}{A model for which forecasts are required.} \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 to suit the new data.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \description{ Applies a fitted average method model to a new dataset. diff --git a/man/residuals.AR.Rd b/man/residuals.AR.Rd index 4f912073..1e03205b 100644 --- a/man/residuals.AR.Rd +++ b/man/residuals.AR.Rd @@ -7,11 +7,11 @@ \method{residuals}{AR}(object, type = c("innovation", "regression"), ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} \item{type}{The type of residuals to extract.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.ARIMA.Rd b/man/residuals.ARIMA.Rd index 8fe0cd1e..299377d6 100644 --- a/man/residuals.ARIMA.Rd +++ b/man/residuals.ARIMA.Rd @@ -7,11 +7,11 @@ \method{residuals}{ARIMA}(object, type = c("innovation", "regression"), ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} \item{type}{The type of residuals to extract.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.ETS.Rd b/man/residuals.ETS.Rd index d47853ad..480f5c42 100644 --- a/man/residuals.ETS.Rd +++ b/man/residuals.ETS.Rd @@ -7,9 +7,9 @@ \method{residuals}{ETS}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.NNETAR.Rd b/man/residuals.NNETAR.Rd index c259be4e..64e67451 100644 --- a/man/residuals.NNETAR.Rd +++ b/man/residuals.NNETAR.Rd @@ -7,9 +7,9 @@ \method{residuals}{NNETAR}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.RW.Rd b/man/residuals.RW.Rd index a35981f6..ccf92700 100644 --- a/man/residuals.RW.Rd +++ b/man/residuals.RW.Rd @@ -7,9 +7,9 @@ \method{residuals}{RW}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.TSLM.Rd b/man/residuals.TSLM.Rd index 75a6ced9..ef3c09a7 100644 --- a/man/residuals.TSLM.Rd +++ b/man/residuals.TSLM.Rd @@ -7,9 +7,9 @@ \method{residuals}{TSLM}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.VAR.Rd b/man/residuals.VAR.Rd index 3d950578..ca48a158 100644 --- a/man/residuals.VAR.Rd +++ b/man/residuals.VAR.Rd @@ -7,9 +7,9 @@ \method{residuals}{VAR}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.croston.Rd b/man/residuals.croston.Rd index ecec5c87..d1640072 100644 --- a/man/residuals.croston.Rd +++ b/man/residuals.croston.Rd @@ -7,9 +7,9 @@ \method{residuals}{croston}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.fable_theta.Rd b/man/residuals.fable_theta.Rd index 8a9e2a96..c51a70ba 100644 --- a/man/residuals.fable_theta.Rd +++ b/man/residuals.fable_theta.Rd @@ -7,9 +7,9 @@ \method{residuals}{fable_theta}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals. diff --git a/man/residuals.model_mean.Rd b/man/residuals.model_mean.Rd index 5ac9d041..b31c303d 100644 --- a/man/residuals.model_mean.Rd +++ b/man/residuals.model_mean.Rd @@ -7,9 +7,9 @@ \method{residuals}{model_mean}(object, ...) } \arguments{ -\item{object}{The time series model used to produce the forecasts} +\item{object}{A model for which forecasts are required.} -\item{...}{Additional arguments for forecast model methods.} +\item{...}{Other arguments passed to methods} } \value{ A vector of fitted residuals.