CausalMixGPD

Summarize a causal workflow bundle

summary.causalmixgpd_causal_bundle() is the bundle-level validation checkpoint for the causal workflow.

Usage

# S3 method for class 'causalmixgpd_causal_bundle'
summary(object, code = FALSE, max_code_lines = 200L, ...)

Arguments

• object:

  A "causalmixgpd_causal_bundle" object.

• code:

  Logical; if TRUE, print generated NIMBLE code for each block.

• max_code_lines:

  Integer; maximum number of code lines to print when code=TRUE.

• …:

  Unused.

Value

The input object (invisibly).

Details

This summary is meant to be read before posterior sampling. It reports the stored propensity-score specification, the treated and control outcome model definitions, and the sample split across treatment arms. In other words, it verifies the model ingredients for the causal decomposition \(e(x), f_0(y \mid x), f_1(y \mid x))\.

Since no MCMC has been run yet, the summary contains only structural information. Posterior treatment-effect summaries become available after run_mcmc_causal through functions such as ate and qte.

See also

print.causalmixgpd_causal_bundle, run_mcmc_causal.

Examples

if (FALSE) { # \dontrun{
cb <- build_causal_bundle(y = y, X = X, A = A, backend = "sb", kernel = "normal")
summary(cb)
} # }