summary.causal_estimates: Summary method for objects of class 'causal_estimates'

View source: R/summary.R

summary.causal_estimatesR Documentation

Summary method for objects of class 'causal_estimates'

Description

Displays a comprehensive summary of causal estimates including effective sample size, mean differences between groups with confidence intervals, and standard deviation ratios.

Usage

## S3 method for class 'causal_estimates'
summary(object, ...)

Arguments

object

An object of class 'causal_estimates' returned by causal.estimate()

...

Additional arguments (currently unused, reserved for future extensions).

Value

No return value, called for side effects (prints summary to console):

  • Percentage sample effective sample size (ESS) for the pseudo-population

  • The mean differences between two groups with their corresponding 95

  • The ratios of standard deviations between two groups with their corresponding 95

Examples


data(demo)

set.seed(1)
result <- causal.estimate(S, Z, X, Y, B = 5, method = "IC", naturalGroupProp)
summary(result)



WMAP documentation built on Oct. 6, 2026, 1:07 a.m.