Skip to contents

Summary for Because Model

Source: R/summary.because.R
summary.because.Rd

Summarizes the output of a Because model run.

Usage

# S3 method for class 'because'
summary(
  object,
  show_internal = FALSE,
  show_nodes = FALSE,
  show_random = FALSE,
  ...
)

Arguments

object

A because object.

show_internal

Logical. If TRUE, shows internal parameters created for deterministically defined nodes (e.g., beta_..._det_...). Defaults to FALSE.

show_nodes

Logical. If TRUE, shows latent node values (e.g., Age[1]). Defaults to FALSE to prevent clutter when monitor="all".

show_random

Logical. If TRUE, shows random effect estimates (e.g., u_...). Defaults to FALSE.

...

Additional arguments passed to summary.mcmc.

Value

A summary object containing statistics for the monitored parameters. If dsep = TRUE was used in because, the summary focuses on the conditional independence tests.

Examples

if (FALSE) { # \dontrun{
fit <- because(list(Y ~ X), data = my_data)

# Standard summary
summary(fit)

# Show latent states and random effects
summary(fit, show_nodes = TRUE, show_random = TRUE)
} # }