From 860a13cce78adf17a7edc8c9a91496116564cedb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Wo=C5=BAniak?= Date: Mon, 18 Mar 2024 10:44:27 +1100 Subject: [PATCH] update on documentation for specify_* #9 + changed wording --- R/specify_bsvarSIGN.R | 6 +++--- man/specify_bsvarSIGN.Rd | 2 +- man/specify_posterior_bsvarSIGN.Rd | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/specify_bsvarSIGN.R b/R/specify_bsvarSIGN.R index 68a7413..f5ffff9 100644 --- a/R/specify_bsvarSIGN.R +++ b/R/specify_bsvarSIGN.R @@ -233,7 +233,7 @@ specify_identification_bsvarSIGN = R6::R6Class( #' R6 Class representing the specification of the BSVARSIGN model #' #' @description -#' The class BSVARSIGN presents complete specification for the bsvar model with sign and narrative restrictions. +#' The class BSVARSIGN presents complete specification for the Bayesian Structural VAR model with sign and narrative restrictions. #' #' @seealso \code{\link{estimate}}, \code{\link{specify_posterior_bsvarSIGN}} #' @@ -422,7 +422,7 @@ specify_bsvarSIGN = R6::R6Class( #' #' @description #' The class PosteriorBSVARSIGN contains posterior output and the specification including -#' the last MCMC draw for the bsvar model with sign and narrative restrictions. +#' the last MCMC draw for the Bayesian Structural VAR model with sign and narrative restrictions. #' Note that due to the thinning of the MCMC output the starting value in element \code{last_draw} #' might not be equal to the last draw provided in element \code{posterior}. #' @@ -450,7 +450,7 @@ specify_posterior_bsvarSIGN = R6::R6Class( #' the starting value to be passed to the continuation of the MCMC estimation using \code{estimate()}. last_draw = list(), - #' @field posterior a list containing Bayesian estimation output collected in elements + #' @field posterior a list containing Bayesian estimation output including: #' an \code{NxNxS} array \code{B}, an \code{NxKxS} array \code{A}, and a \code{5xS} matrix \code{hyper}. posterior = list(), diff --git a/man/specify_bsvarSIGN.Rd b/man/specify_bsvarSIGN.Rd index e376f26..92d9575 100644 --- a/man/specify_bsvarSIGN.Rd +++ b/man/specify_bsvarSIGN.Rd @@ -4,7 +4,7 @@ \alias{specify_bsvarSIGN} \title{R6 Class representing the specification of the BSVARSIGN model} \description{ -The class BSVARSIGN presents complete specification for the bsvar model with sign and narrative restrictions. +The class BSVARSIGN presents complete specification for the Bayesian Structural VAR model with sign and narrative restrictions. } \examples{ data(oil) diff --git a/man/specify_posterior_bsvarSIGN.Rd b/man/specify_posterior_bsvarSIGN.Rd index 79e4024..093d2cf 100644 --- a/man/specify_posterior_bsvarSIGN.Rd +++ b/man/specify_posterior_bsvarSIGN.Rd @@ -5,7 +5,7 @@ \title{R6 Class Representing PosteriorBSVARSIGN} \description{ The class PosteriorBSVARSIGN contains posterior output and the specification including -the last MCMC draw for the bsvar model with sign and narrative restrictions. +the last MCMC draw for the Bayesian Structural VAR model with sign and narrative restrictions. Note that due to the thinning of the MCMC output the starting value in element \code{last_draw} might not be equal to the last draw provided in element \code{posterior}. } @@ -68,7 +68,7 @@ posterior$is_normalised() \item{\code{last_draw}}{an object of class BSVARSIGN with the last draw of the current MCMC run as the starting value to be passed to the continuation of the MCMC estimation using \code{estimate()}.} -\item{\code{posterior}}{a list containing Bayesian estimation output collected in elements +\item{\code{posterior}}{a list containing Bayesian estimation output including: an \code{NxNxS} array \code{B}, an \code{NxKxS} array \code{A}, and a \code{5xS} matrix \code{hyper}.} } \if{html}{\out{}}