From 8161e893302c829fb8f2f436880a8195eff8d201 Mon Sep 17 00:00:00 2001
From: matdehaven <matthew_dehaven@brown.edu>
Date: Mon, 9 Oct 2023 10:12:37 -0400
Subject: [PATCH] Fix doc typo

---
 R/hs.R    | 8 ++++----
 man/hs.Rd | 7 +++++--
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/R/hs.R b/R/hs.R
index 29c9b37..2a7570d 100644
--- a/R/hs.R
+++ b/R/hs.R
@@ -21,7 +21,7 @@ hs <- function(
 
 #' Method to calculate hs for svars (id.chol)
 #'
-#' @param cummulative Boolean.
+#' @param cumulative Boolean.
 #' Default to False, set to True for cummulative shocks.
 #'
 #' @rdname hs
@@ -44,7 +44,7 @@ hs.svars <- function(
         factor(impulse_names, levels = impulse_names, ordered = TRUE)
 
     ## Get residuals and Sigma
-    residuals <- resid(x$VAR)
+    residuals <- stats::resid(x$VAR)
     sigma <- x$B
     t <- nrow(residuals)
 
@@ -74,7 +74,7 @@ hs.svars <- function(
 
 #' Method to calculate hs for fevdvar (id_fevdfd or id_fevdtd)
 #'
-#' @param cummulative Boolean.
+#' @param cumulative Boolean.
 #' Default to False, set to True for cummulative shocks.
 #'
 #' @rdname hs
@@ -97,7 +97,7 @@ hs.fevdvar <- function(
         factor(impulse_names, levels = impulse_names, ordered = TRUE)
 
     ## Get residuals and Sigma
-    residuals <- resid(x$VAR)
+    residuals <- stats::resid(x$VAR)
     sigma <- x$B
     t <- nrow(residuals)
 
diff --git a/man/hs.Rd b/man/hs.Rd
index 5e6311f..a54e573 100644
--- a/man/hs.Rd
+++ b/man/hs.Rd
@@ -11,9 +11,9 @@
 
 hs(x, ...)
 
-\method{hs}{svars}(x, cummulative = FALSE, ...)
+\method{hs}{svars}(x, cumulative = FALSE, ...)
 
-\method{hs}{fevdvar}(x, cummulative = FALSE, ...)
+\method{hs}{fevdvar}(x, cumulative = FALSE, ...)
 }
 \arguments{
 \item{x}{A VAR. Currently supports either a 'svars' or 'fevdvar' object.}
@@ -22,6 +22,9 @@ hs(x, ...)
 Default to False, set to True for cummulative shocks.}
 
 \item{...}{Not currently used.}
+
+\item{cumulative}{Boolean.
+Default to False, set to True for cummulative shocks.}
 }
 \value{
 Class 'fevdhs' list of historical shocks in a data.frame.