R/GI.R

In common2016/MyFun: What the Package Does (One Line, Title Case)

#' Generalized IRF
#'
#' Compute GIRF of linear VAR by Koop et al. (1996)
#'
#' @param ma a list, it's MA coeffients from \code{ar2ma}
#' @param sig_u a cov matrix from VAR models. Note the order of variables in \code{sig_u}
#' is same with one of \code{ma[[i]]}.
#' @param imp_var a numerical scalor which specifies the impulse variable.
#' @param unit \code{'sd'} is one standard devtiation shock which is default,
#'  and \code{'one'} is one unit shock.
#' @return a matrix, its row is variables and its coloumn is horizons.
#' @import magrittr
#' @export
#' @examples
#' # see ar2ma function


GI <- function(ma, sig_u, imp_var = 1, unit = 'sd'){

  # the t period IRF
  GI_single <- function(MA, imp_var){
    ell <- matlab::zeros(nrow(MA),1)
    ell[imp_var] <- 1
    # GVAR toolbox p140, A.22
    if (unit %in% 'sd'){
      irf_single <- (MA %*% sig_u %*% ell)/(as.numeric(sqrt(t(ell) %*% sig_u %*% ell)))
    } else if (unit %in% 'one'){
      irf_single <- (MA %*% sig_u %*% ell)/(as.numeric(t(ell) %*% sig_u %*% ell))
    }
    return(irf_single)
  }

  irf <- lapply(ma, GI_single, imp_var = imp_var)
  ans <- dplyr::bind_cols(irf) %>% as.matrix()
  row.names(ans) <- row.names(ma[[2]])
  return(ans)
}