Plots observed and reconstructed decomposition totals

Compares the observed series with posterior summaries of draw-level sums of the displayed shock contributions and, when requested, the baseline. Filtering components can produce a partial total that does not reconstruct the observed series. Selected shock contributions can also be displayed separately.

Usage

plot_hd_total(
  object,
  probability = 0.9,
  variables = NULL,
  shocks = NULL,
  models = NULL,
  facet_scales = "free_y",
  include_observed = TRUE,
  include_baseline = TRUE,
  shock_groups = NULL,
  top_n = NULL,
  collapse_other = TRUE,
  model = "model1",
  ...
)

Arguments

object: A posterior model object, PosteriorHD, or a tidy table of historical decompositions. Plots that reconstruct the observed series require a posterior model. Combining multiple shocks, including an "Other" component, requires draw-level input: marginal medians and interval bounds cannot be added. Ungrouped summary tables remain supported.
probability: Probability mass of the equal-tailed credible interval computed when object is not already a summary table.
variables: Variables whose historical decompositions are included.
shocks: Structural shocks whose contributions are included.
models: Model specifications to include.
facet_scales: Facet scales passed to ggplot2.
include_observed: If TRUE, include the observed series for plot types that compare decomposition totals against the realised path.
include_baseline: If TRUE, include the non-shock baseline component when building a full decomposition. The baseline is computed before filtering shocks. Displayed marginal medians need not add up to the median of the decomposition total.
shock_groups: Optional named character vector mapping shock names to display groups.
top_n: Optional number of largest contributors to retain within each model-variable panel.
collapse_other: If TRUE, contributors outside top_n (or unmapped shocks under shock_groups) are collapsed into "Other".
model: Model label used when converting posterior objects to posterior-summary tables.
...: Additional arguments passed to tidy_hd() or tidy_hd_event() when conversion is required.