plot.PosteriorRegimePr: Plots estimated regime probabilities

View source: R/plot.R

plot.PosteriorRegimePrR Documentation

Plots estimated regime probabilities

Description

Plots of estimated regime probabilities of Markov-switching heteroskedasticity or allocations of normal-mixture components including their median and percentiles.

Usage

## S3 method for class 'PosteriorRegimePr'
plot(
  x,
  probability = 0.9,
  col = "#ff69b4",
  main,
  xlab,
  mar.multi = c(1, 4.6, 0, 2.1),
  oma.multi = c(6, 0, 5, 0),
  ...
)

Arguments

x

an object of class PosteriorRegimePr obtained using the compute_regime_probabilities() function containing posterior draws of regime probabilities.

probability

a parameter determining the interval to be plotted. The interval stretches from the 0.5 * (1 - probability) to 1 - 0.5 * (1 - probability) percentile of the posterior distribution.

col

a colour of the plot line and the ribbon

main

an alternative main title for the plot

xlab

an alternative x-axis label for the plot

mar.multi

the default mar argument setting in graphics::par. Modify with care!

oma.multi

the default oma argument setting in graphics::par. Modify with care!

...

additional arguments affecting the summary produced.

Author(s)

Tomasz Woźniak wozniak.tom@pm.me

See Also

compute_regime_probabilities

Examples

specification  = specify_bsvar_msh$new(us_fiscal_lsuw)# specify model
burn_in        = estimate(specification, 5)           # run the burn-in
posterior      = estimate(burn_in, 5)                 # estimate the model

# compute regime probabilities
rp             = compute_regime_probabilities(posterior)
plot(rp)                                              # plot

# workflow with the pipe |>
############################################################
us_fiscal_lsuw |>
  specify_bsvar_msh$new() |>
  estimate(S = 5) |> 
  estimate(S = 5) |> 
  compute_regime_probabilities() |>
  plot()


bsvars documentation built on Aug. 22, 2026, 5:09 p.m.