Skip to contents

This plot compares the observed series to the reconstructed decomposition total and can optionally show the baseline component plus selected contributor lines. The decomposition total is built from the same explicit baseline-plus-shock summary used in plot_hd_stacked().

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 historical-decomposition table.

probability

Equal-tailed interval probability used when object is not already a tidy table.

variables

Optional variable filter.

shocks

Optional shock filter applied before grouping.

models

Optional model filter.

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.

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 tidy plotting tables.

...

Additional arguments passed to tidy_hd() or tidy_hd_event() when conversion is required.