add @return #41

bsvars · Jul 19, 2024 · 0cd8707 · 0cd8707
1 parent 2c69dd2
commit 0cd8707
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/R/specify.R b/R/specify.R
@@ -21,6 +21,8 @@
 #' 
 #' @param var positive integer - the index of the variable to which the narrative restriction applies.
 #' 
+#' @return An object of class \code{narrative} specifying one narrative restriction.
+#' 
 #' @examples
 #' # specify a narrative restriction
 #' specify_narrative(start = 166, periods = 1, type = "S", sign = 1, shock = 1, var = 6)