From a094250ce9ad2f9a0f99c26fc7911a94d19d0a0d Mon Sep 17 00:00:00 2001
From: mitchelloharawild <mitch.ohara-wild@monash.edu>
Date: Wed, 25 Sep 2024 01:21:50 +1000
Subject: [PATCH] Update docs

---
 R/VARIMA.R    | 4 ++--
 R/vecm.R      | 2 +-
 man/VARIMA.Rd | 6 +++---
 man/VECM.Rd   | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/R/VARIMA.R b/R/VARIMA.R
index 1da3fab0..55b0d38c 100644
--- a/R/VARIMA.R
+++ b/R/VARIMA.R
@@ -82,7 +82,7 @@ specials_varima <- new_specials(
 #' @aliases report.VARIMA
 #'
 #' @param formula Model specification (see "Specials" section).
-#' @param ic The information criterion used in selecting the model.
+#' @param identification The identification technique used to estimate the model.
 #' @param ... Further arguments for arima
 #'
 #' @section Specials:
@@ -500,7 +500,7 @@ mts_varma_sim <- function(model, innov) {
 #' @param orthogonal If TRUE, orthogonalised impulse responses will be computed.
 #'
 #' @examplesIf requireNamespace("tsibbledata", quietly = TRUE)
-#' IRF(fit, h = 10, impulse = "FTSE")
+#' IRF(fit, h = 10, impulse = "Beer")
 #' 
 #' @export
 IRF.VARIMA <- function(x, new_data, specials, impulse = NULL, orthogonal = FALSE, ...) {
diff --git a/R/vecm.R b/R/vecm.R
index b9264ea8..37b258dc 100644
--- a/R/vecm.R
+++ b/R/vecm.R
@@ -172,7 +172,7 @@ specials_vecm <- new_specials(
 #' formula.
 #'
 #' @param formula Model specification (see "Specials" section).
-#' @param ic The information criterion used in selecting the model.
+#' @param r The number of cointegrating relationships
 #' @param ... Further arguments for arima
 #'
 #' @section Specials:
diff --git a/man/VARIMA.Rd b/man/VARIMA.Rd
index 64459955..e2909629 100644
--- a/man/VARIMA.Rd
+++ b/man/VARIMA.Rd
@@ -40,6 +40,8 @@ VARIMA(formula, identification = c("kronecker_indices", "none"), ...)
 \arguments{
 \item{formula}{Model specification (see "Specials" section).}
 
+\item{identification}{The identification technique used to estimate the model.}
+
 \item{...}{Further arguments for arima}
 
 \item{object}{A model for which forecasts are required.}
@@ -57,8 +59,6 @@ VARIMA(formula, identification = c("kronecker_indices", "none"), ...)
 \item{impulse}{A character string specifying the name of the variable that is shocked (the impulse variable).}
 
 \item{orthogonal}{If TRUE, orthogonalised impulse responses will be computed.}
-
-\item{ic}{The information criterion used in selecting the model.}
 }
 \value{
 A model specification.
@@ -140,7 +140,7 @@ report(fit)
 generate(fit, h = 10)
 \dontshow{\}) # examplesIf}
 \dontshow{if (requireNamespace("tsibbledata", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
-IRF(fit, h = 10, impulse = "FTSE")
+IRF(fit, h = 10, impulse = "Beer")
 \dontshow{\}) # examplesIf}
 }
 \seealso{
diff --git a/man/VECM.Rd b/man/VECM.Rd
index 9341c664..9edc24c2 100644
--- a/man/VECM.Rd
+++ b/man/VECM.Rd
@@ -9,7 +9,7 @@ VECM(formula, ic = c("aicc", "aic", "bic"), r = 1L, ...)
 \arguments{
 \item{formula}{Model specification (see "Specials" section).}
 
-\item{ic}{The information criterion used in selecting the model.}
+\item{r}{The number of cointegrating relationships}
 
 \item{...}{Further arguments for arima}
 }