Skip to content

Commit

Permalink
update on documentation for specify_* #9
Browse files Browse the repository at this point in the history
+ changed wording
  • Loading branch information
donotdespair committed Mar 17, 2024
1 parent 1a438b1 commit 860a13c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions R/specify_bsvarSIGN.R
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
#'
Expand Down Expand Up @@ -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}.
#'
Expand Down Expand Up @@ -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(),

Expand Down
2 changes: 1 addition & 1 deletion man/specify_bsvarSIGN.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/specify_posterior_bsvarSIGN.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 860a13c

Please sign in to comment.