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

Summary method for objects of class 'causal_estimates'

Usage

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

Arguments

object

An object of class 'causal_estimates'

...

Additional arguments affecting the summary produced (so far no additional arguments are needed, so leave blank).

Value

Printed summary of the 'causal_estimates' object, including:

Percentage sample ESS

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

Mean differences with 95% CI (if B > 0)

The mean differences between two groups with their corresponding 95% confidence intervals.

Sigma ratios with 95% CI (if B > 0)

The ratios of standard deviations between two groups with their corresponding 95% confidence intervals.

Mean differences (if B = 0)

The mean differences between two groups.

Sigma ratios (if B = 0)

The ratios of standard deviations between two groups.

Examples

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



WMAP documentation built on April 3, 2025, 8:55 p.m.