From 35fbaec10f91f79ab0984782c16f452ca6fb895f Mon Sep 17 00:00:00 2001 From: mitchelloharawild Date: Fri, 21 May 2021 12:56:39 +1000 Subject: [PATCH] Fix mention of 'ARIMA' regressors in non-ARIMA functions --- .Rbuildignore | 1 + NEWS.md | 4 ++++ R/ar.R | 2 +- R/lm.R | 2 +- R/var.R | 2 +- man/AR.Rd | 2 +- man/TSLM.Rd | 2 +- man/VAR.Rd | 2 +- 8 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 40eb3762..cf95298a 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,3 +16,4 @@ Makefile ^Meta$ ^.github$ ^\.lintr$ +^CRAN-RELEASE$ diff --git a/NEWS.md b/NEWS.md index 96a8b361..a43c3901 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,9 @@ # fable (development version) +## Improvements + +* Documentation improvements. + # fable 0.3.1 Small release to resolve check issues with the development and patched versions diff --git a/R/ar.R b/R/ar.R index 8c8c3df4..82065fc1 100644 --- a/R/ar.R +++ b/R/ar.R @@ -28,7 +28,7 @@ #' } #' #' \subsection{xreg}{ -#' Exogenous regressors can be included in an ARIMA model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. +#' Exogenous regressors can be included in an AR model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. #' #' The inclusion of a constant in the model follows the similar rules to [`stats::lm()`], where including `1` will add a constant and `0` or `-1` will remove the constant. If left out, the inclusion of a constant will be determined by minimising `ic`. #' diff --git a/R/lm.R b/R/lm.R index 02e6eeef..3f42c375 100644 --- a/R/lm.R +++ b/R/lm.R @@ -115,7 +115,7 @@ specials_tslm <- new_specials( #' @section Specials: #' #' \subsection{xreg}{ -#' Exogenous regressors can be included in an ARIMA model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. +#' Exogenous regressors can be included in a TSLM model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. #' \preformatted{ #' xreg(...) #' } diff --git a/R/var.R b/R/var.R index a1e8d9ac..5c277896 100644 --- a/R/var.R +++ b/R/var.R @@ -141,7 +141,7 @@ specials_var <- new_specials( #' } #' #' \subsection{xreg}{ -#' Exogenous regressors can be included in an ARIMA model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. +#' Exogenous regressors can be included in an VAR model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()]. #' #' The inclusion of a constant in the model follows the similar rules to [`stats::lm()`], where including `1` will add a constant and `0` or `-1` will remove the constant. If left out, the inclusion of a constant will be determined by minimising `ic`. #' diff --git a/man/AR.Rd b/man/AR.Rd index af44c4c1..8f56298e 100644 --- a/man/AR.Rd +++ b/man/AR.Rd @@ -42,7 +42,7 @@ order(p = 0:15, fixed = list()) } \subsection{xreg}{ -Exogenous regressors can be included in an ARIMA model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. +Exogenous regressors can be included in an AR model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. The inclusion of a constant in the model follows the similar rules to \code{\link[stats:lm]{stats::lm()}}, where including \code{1} will add a constant and \code{0} or \code{-1} will remove the constant. If left out, the inclusion of a constant will be determined by minimising \code{ic}. diff --git a/man/TSLM.Rd b/man/TSLM.Rd index 89382e5d..9960ffaa 100644 --- a/man/TSLM.Rd +++ b/man/TSLM.Rd @@ -24,7 +24,7 @@ and \code{fourier()}. \subsection{xreg}{ -Exogenous regressors can be included in an ARIMA model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. +Exogenous regressors can be included in a TSLM model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. \preformatted{ xreg(...) } diff --git a/man/VAR.Rd b/man/VAR.Rd index d7cfc6cf..3d1be157 100644 --- a/man/VAR.Rd +++ b/man/VAR.Rd @@ -40,7 +40,7 @@ AR(p = 0:5) } \subsection{xreg}{ -Exogenous regressors can be included in an ARIMA model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. +Exogenous regressors can be included in an VAR model without explicitly using the \code{xreg()} special. Common exogenous regressor specials as specified in \code{\link{common_xregs}} can also be used. These regressors are handled using \code{\link[stats:model.frame]{stats::model.frame()}}, and so interactions and other functionality behaves similarly to \code{\link[stats:lm]{stats::lm()}}. The inclusion of a constant in the model follows the similar rules to \code{\link[stats:lm]{stats::lm()}}, where including \code{1} will add a constant and \code{0} or \code{-1} will remove the constant. If left out, the inclusion of a constant will be determined by minimising \code{ic}.