-
Notifications
You must be signed in to change notification settings - Fork 1
/
bvar_mle.R
786 lines (690 loc) · 30.9 KB
/
bvar_mle.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# ADAPTED VERSION OF ORIGINAL bvar()
#' Hierarchical Bayesian vector autoregression
#'
#' Used to estimate hierarchical Bayesian Vector Autoregression (VAR) models in
#' the fashion of Giannone, Lenza and Primiceri (2015).
#' Priors are adjusted and added via \code{\link{bv_priors}}.
#' The Metropolis-Hastings step can be modified with \code{\link{bv_mh}}.
#'
#' The model can be expressed as:
#' \deqn{y_t = a_0 + A_1 y_{t-1} + ... + A_p y_{t-p} + \epsilon_t}{y_t = a_0 +
#' A_1 y_{t-1} + ... + A_p y_{t-p} + e_t}
#' See Kuschnig and Vashold (2021) and Giannone, Lenza and Primiceri (2015)
#' for further information.
#' Methods for a \code{bvar} object and its derivatives can be used to:
#' \itemize{
#' \item predict and analyse scenarios;
#' \item evaluate shocks and the variance of forecast errors;
#' \item visualise forecasts and impulse responses, parameters and residuals;
#' \item retrieve coefficents and the variance-covariance matrix;
#' \item calculate fitted and residual values;
#' }
#' Note that these methods generally work by calculating quantiles from the
#' posterior draws. The full posterior may be retrieved directly from the
#' objects. The function \code{\link[utils]{str}} can be very helpful for this.
#'
#' @author Nikolas Kuschnig, Lukas Vashold
#'
#' @param data Numeric matrix or dataframe. Note that observations are expected
#' to be ordered from earliest to latest, and variables in the columns.
#' @param lags Integer scalar. Lag order of the model.
#' @param n_draw,n_burn Integer scalar. The number of iterations to (a) cycle
#' through and (b) burn at the start.
#' @param n_thin Integer scalar. Every \emph{n_thin}'th iteration is stored.
#' For a given memory requirement thinning reduces autocorrelation, while
#' increasing effective sample size.
#' @param priors Object from \code{\link{bv_priors}} with prior settings.
#' Used to adjust the Minnesota prior, add custom dummy priors, and choose
#' hyperparameters for hierarchical estimation.
#' @param mh Object from \code{\link{bv_mh}} with settings for the
#' Metropolis-Hastings step. Used to tune automatic adjustment of the
#' acceptance rate within the burn-in period, or manually adjust the proposal
#' variance.
#' @param fcast Object from \code{\link{bv_fcast}} with forecast settings.
#' Options include the horizon and settings for conditional forecasts i.e.
#' scenario analysis.
#' May also be calculated ex-post using \code{\link{predict.bvar}}.
#' @param irf Object from \code{\link{bv_irf}} with settings for the calculation
#' of impulse responses and forecast error variance decompositions. Options
#' include the horizon and different identification schemes.
#' May also be calculated ex-post using \code{\link{irf.bvar}}.
#' @param verbose Logical scalar. Whether to print intermediate results and
#' progress.
#' @param ... Not used.
#'
#' @return Returns a list of class \code{bvar} with the following elements:
#' \itemize{
#' \item \code{beta} - Numeric array with draws from the posterior of the VAR
#' coefficients. Also see \code{\link{coef.bvar}}.
#' \item \code{sigma} - Numeric array with draws from the posterior of the
#' variance-covariance matrix. Also see \code{\link{vcov.bvar}}.
#' \item \code{hyper} - Numeric matrix with draws from the posterior of the
#' hierarchically treated hyperparameters.
#' \item \code{ml} - Numeric vector with the marginal likelihood (with respect
#' to the hyperparameters), that determines acceptance probability.
#' \item \code{optim} - List with outputs of \code{\link[stats]{optim}},
#' which is used to find starting values for the hyperparameters.
#' \item \code{prior} - Prior settings from \code{\link{bv_priors}}.
#' \item \code{call} - Call to the function. See \code{\link{match.call}}.
#' \item \code{meta} - List with meta information. Includes the number of
#' variables, accepted draws, number of iterations, and data.
#' \item \code{variables} - Character vector with the column names of
#' \emph{data}. If missing, variables are named iteratively.
#' \item \code{explanatories} - Character vector with names of explanatory
#' variables. Formatting is akin to: \code{"FEDFUNDS-lag1"}.
#' \item \code{fcast} - Forecasts from \code{\link{predict.bvar}}.
#' \item \code{irf} - Impulse responses from \code{\link{irf.bvar}}.
#' }
#'
#' @references
#' Giannone, D. and Lenza, M. and Primiceri, G. E. (2015) Prior Selection for
#' Vector Autoregressions. \emph{The Review of Economics and Statistics},
#' \bold{97:2}, 436-451, \doi{10.1162/REST_a_00483}.
#'
#' Kuschnig, N. and Vashold, L. (2021) BVAR: Bayesian Vector Autoregressions
#' with Hierarchical Prior Selection in R.
#' \emph{Journal of Statistical Software}, \bold{14}, 1-27,
#' \doi{10.18637/jss.v100.i14}.
#'
#' @seealso \code{\link{bv_priors}}; \code{\link{bv_mh}};
#' \code{\link{bv_fcast}}; \code{\link{bv_irf}};
#' \code{\link{predict.bvar}}; \code{\link{irf.bvar}}; \code{\link{plot.bvar}};
#'
#' @keywords BVAR Metropolis-Hastings MCMC priors hierarchical
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
#' @importFrom stats optim runif quantile
#' @importFrom mvtnorm rmvnorm
#'
#' @examples
#' # Access a subset of the fred_qd dataset
#' data <- fred_qd[, c("CPIAUCSL", "UNRATE", "FEDFUNDS")]
#' # Transform it to be stationary
#' data <- fred_transform(data, codes = c(5, 5, 1), lag = 4)
#'
#' # Estimate a BVAR using one lag, default settings and very few draws
#' x <- bvar(data, lags = 1, n_draw = 1000L, n_burn = 200L, verbose = FALSE)
#'
#' # Calculate and store forecasts and impulse responses
#' predict(x) <- predict(x, horizon = 8)
#' irf(x) <- irf(x, horizon = 8, fevd = FALSE)
#'
#' \dontrun{
#' # Check convergence of the hyperparameters with a trace and density plot
#' plot(x)
#' # Plot forecasts and impulse responses
#' plot(predict(x))
#' plot(irf(x))
#' # Check coefficient values and variance-covariance matrix
#' summary(x)
#' }
bvar_mle <- function(
data, lags,
n_draw = 10000L, n_burn = 5000L, n_thin = 1L,
priors = bv_priors(),
mh = bv_mh(),
fcast = NULL,
irf = NULL,
verbose = TRUE, ...) {
cl <- match.call()
start_time <- Sys.time()
# Setup and checks -----
# Data
if(!all(vapply(data, is.numeric, logical(1L))) ||
any(is.na(data)) || ncol(data) < 2) {
stop("Problem with the data. Make sure it is numeric, without any NAs.")
}
Y <- as.matrix(data)
# Integers
lags <- BVAR:::int_check(lags, min = 1L, max = nrow(Y) - 1, msg = "Issue with lags.")
n_draw <- BVAR:::int_check(n_draw, min = 10L, msg = "Issue with n_draw.")
n_burn <- BVAR:::int_check(n_burn, min = 0L, max = n_draw - 1L,
msg = "Issue with n_burn. Is n_burn < n_draw?")
n_thin <- BVAR:::int_check(n_thin, min = 1L, max = ((n_draw - n_burn) / 10),
msg = "Issue with n_thin. Maximum allowed is (n_draw - n_burn) / 10.")
n_save <- BVAR:::int_check(((n_draw - n_burn) / n_thin), min = 1L)
verbose <- isTRUE(verbose)
# Constructors, required
if(!inherits(priors, "bv_priors")) {
stop("Please use `bv_priors()` to configure the priors.")
}
if(!inherits(mh, "bv_metropolis")) {
stop("Please use `bv_mh()` to configure the Metropolis-Hastings step.")
}
# Not required
if(!is.null(fcast) && !inherits(fcast, "bv_fcast")) {
stop("Please use `bv_fcast()` to configure forecasts.")
}
if(!is.null(irf) && !inherits(irf, "bv_irf")) {
stop("Please use `bv_irf()` to configure impulse responses.")
}
if(mh[["adjust_acc"]]) {n_adj <- as.integer(n_burn * mh[["adjust_burn"]])}
# Preparation ---
X <- BVAR:::lag_var(Y, lags = lags)
Y <- Y[(lags + 1):nrow(Y), ]
X <- X[(lags + 1):nrow(X), ]
X <- cbind(1, X)
XX <- crossprod(X)
K <- ncol(X)
M <- ncol(Y)
N <- nrow(Y)
variables <- BVAR:::name_deps(variables = colnames(data), M = M)
explanatories <- BVAR:::name_expl(variables = variables, M = M, lags = lags)
# Priors -----
# Minnesota prior ---
b <- priors[["b"]]
if(length(b) == 1 || length(b) == M) {
priors[["b"]] <- matrix(0, nrow = K, ncol = M)
priors[["b"]][2:(M + 1), ] <- diag(b, M)
} else if(!is.matrix(b) || !all(dim(b) == c(K, M))) {
stop("Issue with the prior mean b. Please reconstruct.")
}
if(any(priors[["psi"]][["mode"]] == "auto")) {
psi_temp <- BVAR:::auto_psi(Y, lags)
priors[["psi"]][["mode"]] <- psi_temp[["mode"]]
priors[["psi"]][["min"]] <- psi_temp[["min"]]
priors[["psi"]][["max"]] <- psi_temp[["max"]]
}
if(!all(vapply(priors[["psi"]][1:3],
function(x) length(x) == M, logical(1L)))) {
stop("Dimensions of psi do not fit the data.")
}
# Parameters ---
pars_names <- names(priors)[ # Exclude reserved names
!grepl("^hyper$|^var$|^b$|^psi[0-9]+$|^dummy$", names(priors))]
pars_full <- do.call(c, lapply(pars_names, function(x) priors[[x]][["mode"]]))
names(pars_full) <- BVAR:::name_pars(pars_names, M)
# Hierarchical priors ---
hyper_n <- length(priors[["hyper"]]) +
sum(priors[["hyper"]] == "psi") * (M - 1)
if(hyper_n == 0) {stop("Please provide at least one hyperparameter.")}
get_priors <- function(name, par) {priors[[name]][[par]]}
hyper <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "mode"))
hyper_min <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "min"))
hyper_max <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "max"))
names(hyper) <- BVAR:::name_pars(priors[["hyper"]], M)
# Split up psi ---
for(i in seq_along(priors[["psi"]][["mode"]])) {
priors[[paste0("psi", i)]] <- vapply(c("mode", "min", "max"), function(x) {
priors[["psi"]][[x]][i]}, numeric(1L))
}
# Optimise and draw -----
opt <- optim(par = hyper, BVAR:::bv_ml, gr = NULL,
hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags,
opt = TRUE, method = "L-BFGS-B", lower = hyper_min, upper = hyper_max,
control = list("fnscale" = -1))
names(opt[["par"]]) <- names(hyper)
if(verbose) {
cat("Optimisation concluded.",
"\nPosterior marginal likelihood: ", round(opt[["value"]], 3),
"\nHyperparameters: ", paste(names(hyper), round(opt[["par"]], 5),
sep = " = ", collapse = "; "), "\n", sep = "")
}
# Hessian ---
if(length(mh[["scale_hess"]]) != 1 &&
length(mh[["scale_hess"]]) != length(hyper)) {
stop("Length of scale_hess does not match the ", length(hyper),
" hyperparameters. Please provide a scalar or an element for every ",
"hyperparameter (see `?bv_mn()`).")
}
H <- diag(length(opt[["par"]])) * mh[["scale_hess"]]
J <- unlist(lapply(names(hyper), function(name) {
exp(opt[["par"]][[name]]) / (1 + exp(opt[["par"]][[name]])) ^ 2 *
(priors[[name]][["max"]] - priors[[name]][["min"]])
}))
if(any(is.nan(J))) {
stop("Issue with parameter(s) ",
paste0(names(hyper)[which(is.nan(J))], collapse = ", "), ". ",
"Their mode(s) may be too large to exponentiate.")
}
if(hyper_n != 1) {J <- diag(J)}
HH <- J %*% H %*% t(J)
# Make sure HH is positive definite
if(hyper_n != 1) {
HH_eig <- eigen(HH)
HH_eig[["values"]] <- abs(HH_eig[["values"]])
HH <- HH_eig
} else {HH <- list("values" = abs(HH))}
# Initial draw ---
while(TRUE) {
hyper_draw <- BVAR:::rmvn_proposal(n = 1, mean = opt[["par"]], sigma = HH)[1, ]
ml_draw <- BVAR:::bv_ml(hyper = hyper_draw,
hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags)
if(ml_draw[["log_ml"]] > -1e16) {break}
}
# Sampling -----
# Storage ---
accepted <- 0 -> accepted_adj # Beauty
ml_store <- ml_draw[["log_ml"]]
hyper_store <- hyper_draw
beta_store <- ml_draw[["beta_hat"]]
sigma_store <- ml_draw[["sse"]] / ml_draw[["N"]] #ml_draw[["omega_inv"]]
# if(verbose) {pb <- txtProgressBar(min = 0, max = n_draw, style = 3)}
#
# # Start loop ---
# for(i in seq.int(1 - n_burn, n_draw - n_burn)) {
#
# # Metropolis-Hastings
# hyper_temp <- rmvn_proposal(n = 1, mean = hyper_draw, sigma = HH)[1, ]
# ml_temp <- bv_ml(hyper = hyper_temp,
# hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
# priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags)
#
# if(runif(1) < exp(ml_temp[["log_ml"]] - ml_draw[["log_ml"]])) { # Accept
# ml_draw <- ml_temp
# hyper_draw <- hyper_temp
# accepted_adj <- accepted_adj + 1
# if(i > 0) {accepted <- accepted + 1}
# }
#
# # Tune acceptance during burn-in phase
# if(mh[["adjust_acc"]] && i <= -n_adj && (i + n_burn) %% 10 == 0) {
# acc_rate <- accepted_adj / (i + n_burn)
# if(acc_rate < mh[["acc_lower"]]) {
# HH[["values"]] <- HH[["values"]] * mh[["acc_tighten"]]
# } else if(acc_rate > mh[["acc_upper"]]) {
# HH[["values"]] <- HH[["values"]] * mh[["acc_loosen"]]
# }
# }
#
# if(i > 0 && i %% n_thin == 0) { # Store draws
#
# ml_store[(i / n_thin)] <- ml_draw[["log_ml"]]
# hyper_store[(i / n_thin), ] <- hyper_draw
#
# # Draw parameters, i.e. beta_draw and sigma_draw
# # These need X and N with the dummy observations from `ml_draw`
# draws <- draw_post(XX = ml_draw[["XX"]], N = ml_draw[["N"]],
# M = M, lags = lags, b = priors[["b"]], psi = ml_draw[["psi"]],
# sse = ml_draw[["sse"]], beta_hat = ml_draw[["beta_hat"]],
# omega_inv = ml_draw[["omega_inv"]])
#
# beta_store[(i / n_thin), , ] <- draws[["beta_draw"]]
# sigma_store[(i / n_thin), , ] <- draws[["sigma_draw"]]
#
# } # End store
#
# if(verbose) {setTxtProgressBar(pb, (i + n_burn))}
#
# } # End loop
timer <- Sys.time() - start_time
if(verbose) {
#close(pb)
cat("Finished ML Calc after ", format(round(timer, 2)), ".\n", sep = "")
}
# Outputs -----
out <- structure(list(
"beta" = beta_store, "sigma" = sigma_store,
"hyper" = hyper_store, "ml" = ml_store,
"optim" = opt, "priors" = priors, "call" = cl,
"variables" = variables, "explanatories" = explanatories,
"meta" = list("accepted" = accepted, "timer" = timer,
"Y" = Y, "X" = X, "N" = N, "K" = K, "M" = M, "lags" = lags,
"n_draw" = n_draw, "n_burn" = n_burn, "n_save" = n_save,
"n_thin" = n_thin)
), class = "bvar")
if(!is.null(irf)) {
if(verbose) {cat("Calculating impulse responses.")}
out[["irf"]] <- tryCatch(irf.bvar(out, irf), error = function(e) {
warning("\nImpulse response calculation failed with:\n", e)
return(NULL)})
if(verbose) {cat("..Done!\n")}
}
if(!is.null(fcast)) {
if(verbose) {cat("Calculating forecasts.")}
out[["fcast"]] <- tryCatch(predict.bvar(out, fcast), error = function(e) {
warning("\nForecast calculation failed with:\n", e)
return(NULL)})
if(verbose) {cat("..Done!\n")}
}
return(out)
}
# ADAPTED VERSION OF ORIGINAL bvar()
#' Hierarchical Bayesian vector autoregression
#'
#' Used to estimate hierarchical Bayesian Vector Autoregression (VAR) models in
#' the fashion of Giannone, Lenza and Primiceri (2015).
#' Priors are adjusted and added via \code{\link{bv_priors}}.
#' The Metropolis-Hastings step can be modified with \code{\link{bv_mh}}.
#'
#' The model can be expressed as:
#' \deqn{y_t = a_0 + A_1 y_{t-1} + ... + A_p y_{t-p} + \epsilon_t}{y_t = a_0 +
#' A_1 y_{t-1} + ... + A_p y_{t-p} + e_t}
#' See Kuschnig and Vashold (2021) and Giannone, Lenza and Primiceri (2015)
#' for further information.
#' Methods for a \code{bvar} object and its derivatives can be used to:
#' \itemize{
#' \item predict and analyse scenarios;
#' \item evaluate shocks and the variance of forecast errors;
#' \item visualise forecasts and impulse responses, parameters and residuals;
#' \item retrieve coefficents and the variance-covariance matrix;
#' \item calculate fitted and residual values;
#' }
#' Note that these methods generally work by calculating quantiles from the
#' posterior draws. The full posterior may be retrieved directly from the
#' objects. The function \code{\link[utils]{str}} can be very helpful for this.
#'
#' @author Nikolas Kuschnig, Lukas Vashold
#'
#' @param data Numeric matrix or dataframe. Note that observations are expected
#' to be ordered from earliest to latest, and variables in the columns.
#' @param lags Integer scalar. Lag order of the model.
#' @param n_draw,n_burn Integer scalar. The number of iterations to (a) cycle
#' through and (b) burn at the start.
#' @param n_thin Integer scalar. Every \emph{n_thin}'th iteration is stored.
#' For a given memory requirement thinning reduces autocorrelation, while
#' increasing effective sample size.
#' @param priors Object from \code{\link{bv_priors}} with prior settings.
#' Used to adjust the Minnesota prior, add custom dummy priors, and choose
#' hyperparameters for hierarchical estimation.
#' @param mh Object from \code{\link{bv_mh}} with settings for the
#' Metropolis-Hastings step. Used to tune automatic adjustment of the
#' acceptance rate within the burn-in period, or manually adjust the proposal
#' variance.
#' @param fcast Object from \code{\link{bv_fcast}} with forecast settings.
#' Options include the horizon and settings for conditional forecasts i.e.
#' scenario analysis.
#' May also be calculated ex-post using \code{\link{predict.bvar}}.
#' @param irf Object from \code{\link{bv_irf}} with settings for the calculation
#' of impulse responses and forecast error variance decompositions. Options
#' include the horizon and different identification schemes.
#' May also be calculated ex-post using \code{\link{irf.bvar}}.
#' @param verbose Logical scalar. Whether to print intermediate results and
#' progress.
#' @param ... Not used.
#'
#' @return Returns a list of class \code{bvar} with the following elements:
#' \itemize{
#' \item \code{beta} - Numeric array with draws from the posterior of the VAR
#' coefficients. Also see \code{\link{coef.bvar}}.
#' \item \code{sigma} - Numeric array with draws from the posterior of the
#' variance-covariance matrix. Also see \code{\link{vcov.bvar}}.
#' \item \code{hyper} - Numeric matrix with draws from the posterior of the
#' hierarchically treated hyperparameters.
#' \item \code{ml} - Numeric vector with the marginal likelihood (with respect
#' to the hyperparameters), that determines acceptance probability.
#' \item \code{optim} - List with outputs of \code{\link[stats]{optim}},
#' which is used to find starting values for the hyperparameters.
#' \item \code{prior} - Prior settings from \code{\link{bv_priors}}.
#' \item \code{call} - Call to the function. See \code{\link{match.call}}.
#' \item \code{meta} - List with meta information. Includes the number of
#' variables, accepted draws, number of iterations, and data.
#' \item \code{variables} - Character vector with the column names of
#' \emph{data}. If missing, variables are named iteratively.
#' \item \code{explanatories} - Character vector with names of explanatory
#' variables. Formatting is akin to: \code{"FEDFUNDS-lag1"}.
#' \item \code{fcast} - Forecasts from \code{\link{predict.bvar}}.
#' \item \code{irf} - Impulse responses from \code{\link{irf.bvar}}.
#' }
#'
#' @references
#' Giannone, D. and Lenza, M. and Primiceri, G. E. (2015) Prior Selection for
#' Vector Autoregressions. \emph{The Review of Economics and Statistics},
#' \bold{97:2}, 436-451, \doi{10.1162/REST_a_00483}.
#'
#' Kuschnig, N. and Vashold, L. (2021) BVAR: Bayesian Vector Autoregressions
#' with Hierarchical Prior Selection in R.
#' \emph{Journal of Statistical Software}, \bold{14}, 1-27,
#' \doi{10.18637/jss.v100.i14}.
#'
#' @seealso \code{\link{bv_priors}}; \code{\link{bv_mh}};
#' \code{\link{bv_fcast}}; \code{\link{bv_irf}};
#' \code{\link{predict.bvar}}; \code{\link{irf.bvar}}; \code{\link{plot.bvar}};
#'
#' @keywords BVAR Metropolis-Hastings MCMC priors hierarchical
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
#' @importFrom stats optim runif quantile
#' @importFrom mvtnorm rmvnorm
#'
#' @examples
#' # Access a subset of the fred_qd dataset
#' data <- fred_qd[, c("CPIAUCSL", "UNRATE", "FEDFUNDS")]
#' # Transform it to be stationary
#' data <- fred_transform(data, codes = c(5, 5, 1), lag = 4)
#'
#' # Estimate a BVAR using one lag, default settings and very few draws
#' x <- bvar(data, lags = 1, n_draw = 1000L, n_burn = 200L, verbose = FALSE)
#'
#' # Calculate and store forecasts and impulse responses
#' predict(x) <- predict(x, horizon = 8)
#' irf(x) <- irf(x, horizon = 8, fevd = FALSE)
#'
#' \dontrun{
#' # Check convergence of the hyperparameters with a trace and density plot
#' plot(x)
#' # Plot forecasts and impulse responses
#' plot(predict(x))
#' plot(irf(x))
#' # Check coefficient values and variance-covariance matrix
#' summary(x)
#' }
bvar_mle <- function(
data, lags,
n_draw = 10000L, n_burn = 5000L, n_thin = 1L,
priors = bv_priors(),
mh = bv_mh(),
fcast = NULL,
irf = NULL,
verbose = TRUE, ...) {
cl <- match.call()
start_time <- Sys.time()
# Setup and checks -----
# Data
if(!all(vapply(data, is.numeric, logical(1L))) ||
any(is.na(data)) || ncol(data) < 2) {
stop("Problem with the data. Make sure it is numeric, without any NAs.")
}
Y <- as.matrix(data)
# Integers
lags <- BVAR:::int_check(lags, min = 1L, max = nrow(Y) - 1, msg = "Issue with lags.")
n_draw <- BVAR:::int_check(n_draw, min = 10L, msg = "Issue with n_draw.")
n_burn <- BVAR:::int_check(n_burn, min = 0L, max = n_draw - 1L,
msg = "Issue with n_burn. Is n_burn < n_draw?")
n_thin <- BVAR:::int_check(n_thin, min = 1L, max = ((n_draw - n_burn) / 10),
msg = "Issue with n_thin. Maximum allowed is (n_draw - n_burn) / 10.")
n_save <- BVAR:::int_check(((n_draw - n_burn) / n_thin), min = 1L)
verbose <- isTRUE(verbose)
# Constructors, required
if(!inherits(priors, "bv_priors")) {
stop("Please use `bv_priors()` to configure the priors.")
}
if(!inherits(mh, "bv_metropolis")) {
stop("Please use `bv_mh()` to configure the Metropolis-Hastings step.")
}
# Not required
if(!is.null(fcast) && !inherits(fcast, "bv_fcast")) {
stop("Please use `bv_fcast()` to configure forecasts.")
}
if(!is.null(irf) && !inherits(irf, "bv_irf")) {
stop("Please use `bv_irf()` to configure impulse responses.")
}
if(mh[["adjust_acc"]]) {n_adj <- as.integer(n_burn * mh[["adjust_burn"]])}
# Preparation ---
X <- BVAR:::lag_var(Y, lags = lags)
Y <- Y[(lags + 1):nrow(Y), ]
X <- X[(lags + 1):nrow(X), ]
X <- cbind(1, X)
XX <- crossprod(X)
K <- ncol(X)
M <- ncol(Y)
N <- nrow(Y)
variables <- BVAR:::name_deps(variables = colnames(data), M = M)
explanatories <- BVAR:::name_expl(variables = variables, M = M, lags = lags)
# Priors -----
# Minnesota prior ---
b <- priors[["b"]]
if(length(b) == 1 || length(b) == M) {
priors[["b"]] <- matrix(0, nrow = K, ncol = M)
priors[["b"]][2:(M + 1), ] <- diag(b, M)
} else if(!is.matrix(b) || !all(dim(b) == c(K, M))) {
stop("Issue with the prior mean b. Please reconstruct.")
}
if(any(priors[["psi"]][["mode"]] == "auto")) {
psi_temp <- BVAR:::auto_psi(Y, lags)
priors[["psi"]][["mode"]] <- psi_temp[["mode"]]
priors[["psi"]][["min"]] <- psi_temp[["min"]]
priors[["psi"]][["max"]] <- psi_temp[["max"]]
}
if(!all(vapply(priors[["psi"]][1:3],
function(x) length(x) == M, logical(1L)))) {
stop("Dimensions of psi do not fit the data.")
}
# Parameters ---
pars_names <- names(priors)[ # Exclude reserved names
!grepl("^hyper$|^var$|^b$|^psi[0-9]+$|^dummy$", names(priors))]
pars_full <- do.call(c, lapply(pars_names, function(x) priors[[x]][["mode"]]))
names(pars_full) <- BVAR:::name_pars(pars_names, M)
# Hierarchical priors ---
hyper_n <- length(priors[["hyper"]]) +
sum(priors[["hyper"]] == "psi") * (M - 1)
if(hyper_n == 0) {stop("Please provide at least one hyperparameter.")}
get_priors <- function(name, par) {priors[[name]][[par]]}
hyper <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "mode"))
hyper_min <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "min"))
hyper_max <- do.call(c, lapply(priors[["hyper"]], get_priors, par = "max"))
names(hyper) <- BVAR:::name_pars(priors[["hyper"]], M)
# Split up psi ---
for(i in seq_along(priors[["psi"]][["mode"]])) {
priors[[paste0("psi", i)]] <- vapply(c("mode", "min", "max"), function(x) {
priors[["psi"]][[x]][i]}, numeric(1L))
}
# Optimise and draw -----
opt <- optim(par = hyper, BVAR:::bv_ml, gr = NULL,
hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags,
opt = TRUE, method = "L-BFGS-B", lower = hyper_min, upper = hyper_max,
control = list("fnscale" = -1))
names(opt[["par"]]) <- names(hyper)
if(verbose) {
cat("Optimisation concluded.",
"\nPosterior marginal likelihood: ", round(opt[["value"]], 3),
"\nHyperparameters: ", paste(names(hyper), round(opt[["par"]], 5),
sep = " = ", collapse = "; "), "\n", sep = "")
}
# Hessian ---
if(length(mh[["scale_hess"]]) != 1 &&
length(mh[["scale_hess"]]) != length(hyper)) {
stop("Length of scale_hess does not match the ", length(hyper),
" hyperparameters. Please provide a scalar or an element for every ",
"hyperparameter (see `?bv_mn()`).")
}
H <- diag(length(opt[["par"]])) * mh[["scale_hess"]]
J <- unlist(lapply(names(hyper), function(name) {
exp(opt[["par"]][[name]]) / (1 + exp(opt[["par"]][[name]])) ^ 2 *
(priors[[name]][["max"]] - priors[[name]][["min"]])
}))
if(any(is.nan(J))) {
stop("Issue with parameter(s) ",
paste0(names(hyper)[which(is.nan(J))], collapse = ", "), ". ",
"Their mode(s) may be too large to exponentiate.")
}
if(hyper_n != 1) {J <- diag(J)}
HH <- J %*% H %*% t(J)
# Make sure HH is positive definite
if(hyper_n != 1) {
HH_eig <- eigen(HH)
HH_eig[["values"]] <- abs(HH_eig[["values"]])
HH <- HH_eig
} else {HH <- list("values" = abs(HH))}
# Initial draw ---
while(TRUE) {
hyper_draw <- BVAR:::rmvn_proposal(n = 1, mean = opt[["par"]], sigma = HH)[1, ]
ml_draw <- BVAR:::bv_ml(hyper = hyper_draw,
hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags)
if(ml_draw[["log_ml"]] > -1e16) {break}
}
# Sampling -----
# Storage ---
accepted <- 0 -> accepted_adj # Beauty
ml_store <- vector("numeric", n_save)
hyper_store <- hyper_draw
beta_store <- ml_draw[["beta_hat"]]
sigma_store <- ml_draw[["omega_inv"]]
# if(verbose) {pb <- txtProgressBar(min = 0, max = n_draw, style = 3)}
#
# # Start loop ---
# for(i in seq.int(1 - n_burn, n_draw - n_burn)) {
#
# # Metropolis-Hastings
# hyper_temp <- rmvn_proposal(n = 1, mean = hyper_draw, sigma = HH)[1, ]
# ml_temp <- bv_ml(hyper = hyper_temp,
# hyper_min = hyper_min, hyper_max = hyper_max, pars = pars_full,
# priors = priors, Y = Y, X = X, XX = XX, K = K, M = M, N = N, lags = lags)
#
# if(runif(1) < exp(ml_temp[["log_ml"]] - ml_draw[["log_ml"]])) { # Accept
# ml_draw <- ml_temp
# hyper_draw <- hyper_temp
# accepted_adj <- accepted_adj + 1
# if(i > 0) {accepted <- accepted + 1}
# }
#
# # Tune acceptance during burn-in phase
# if(mh[["adjust_acc"]] && i <= -n_adj && (i + n_burn) %% 10 == 0) {
# acc_rate <- accepted_adj / (i + n_burn)
# if(acc_rate < mh[["acc_lower"]]) {
# HH[["values"]] <- HH[["values"]] * mh[["acc_tighten"]]
# } else if(acc_rate > mh[["acc_upper"]]) {
# HH[["values"]] <- HH[["values"]] * mh[["acc_loosen"]]
# }
# }
#
# if(i > 0 && i %% n_thin == 0) { # Store draws
#
# ml_store[(i / n_thin)] <- ml_draw[["log_ml"]]
# hyper_store[(i / n_thin), ] <- hyper_draw
#
# # Draw parameters, i.e. beta_draw and sigma_draw
# # These need X and N with the dummy observations from `ml_draw`
# draws <- draw_post(XX = ml_draw[["XX"]], N = ml_draw[["N"]],
# M = M, lags = lags, b = priors[["b"]], psi = ml_draw[["psi"]],
# sse = ml_draw[["sse"]], beta_hat = ml_draw[["beta_hat"]],
# omega_inv = ml_draw[["omega_inv"]])
#
# beta_store[(i / n_thin), , ] <- draws[["beta_draw"]]
# sigma_store[(i / n_thin), , ] <- draws[["sigma_draw"]]
#
# } # End store
#
# if(verbose) {setTxtProgressBar(pb, (i + n_burn))}
#
# } # End loop
timer <- Sys.time() - start_time
if(verbose) {
#close(pb)
cat("Finished ML Calc after ", format(round(timer, 2)), ".\n", sep = "")
}
# Outputs -----
out <- structure(list(
"beta" = beta_store, "sigma" = sigma_store,
"hyper" = hyper_store, "ml" = ml_store,
"optim" = opt, "priors" = priors, "call" = cl,
"variables" = variables, "explanatories" = explanatories,
"meta" = list("accepted" = accepted, "timer" = timer,
"Y" = Y, "X" = X, "N" = N, "K" = K, "M" = M, "lags" = lags,
"n_draw" = n_draw, "n_burn" = n_burn, "n_save" = n_save,
"n_thin" = n_thin)
), class = "bvar")
if(!is.null(irf)) {
if(verbose) {cat("Calculating impulse responses.")}
out[["irf"]] <- tryCatch(irf.bvar(out, irf), error = function(e) {
warning("\nImpulse response calculation failed with:\n", e)
return(NULL)})
if(verbose) {cat("..Done!\n")}
}
if(!is.null(fcast)) {
if(verbose) {cat("Calculating forecasts.")}
out[["fcast"]] <- tryCatch(predict.bvar(out, fcast), error = function(e) {
warning("\nForecast calculation failed with:\n", e)
return(NULL)})
if(verbose) {cat("..Done!\n")}
}
return(out)
}