Plots stacked historical decomposition contributions over time
Source:R/plot-hd.R
plot_hd_stacked.RdPlots posterior median structural-shock contributions as stacked areas over
time. Set include_baseline = TRUE to include the non-shock
"Baseline" component in the displayed decomposition.
Usage
plot_hd_stacked(
object,
probability = 0.9,
variables = NULL,
shocks = NULL,
models = NULL,
facet_scales = "free_y",
include_observed = FALSE,
include_baseline = FALSE,
shock_groups = NULL,
top_n = NULL,
collapse_other = TRUE,
stack = c("signed", "absolute"),
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
objectis 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 outsidetop_n(or unmapped shocks undershock_groups) are collapsed into"Other".- stack
One of
"signed"or"absolute"for stacked plots.- model
Model label used when converting posterior objects to posterior-summary tables.
- ...
Additional arguments passed to
tidy_hd()ortidy_hd_event()when conversion is required.