update example in specify_narrative #42

bsvars · Jul 24, 2024 · 2758830 · 2758830
1 parent d9f2043
commit 2758830
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/R/specify.R b/R/specify.R
@@ -25,7 +25,16 @@
 #' 
 #' @examples
 #' # specify a narrative restriction
-#' specify_narrative(start = 166, periods = 1, type = "S", sign = 1, shock = 1, var = 6)
+#' narrative       = specify_narrative(
+#'                     start = 166, 
+#'                     periods = 1, 
+#'                     type = "S", 
+#'                     sign = 1, 
+#'                     shock = 1, 
+#'                     var = 6
+#'                   )
+#' # use it to specify the model
+#' specification   = specify_bsvarSIGN$new(monetary, sign_narrative = list(narrative))
 #' 
 #' @export
 specify_narrative = function(start, periods = 1, type = "S", sign = 1, shock = 1, var = NA) {

diff --git a/man/specify_narrative.Rd b/man/specify_narrative.Rd