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

View source: R/summary.R

summary.balancing_weightsR Documentation

Summary method for objects of class 'balancing_weights'

Description

Displays a summary of balancing weights including the numnber of weights. their distribution, and the effective sample size.

Usage

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

Arguments

object

An object of class 'balancing_weights' returned by balancing.weights().

...

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

Value

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

  • The total number of weights

  • Statistical summary of weight values

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

Examples


data(demo)
result <- balancing.weights(S, Z, X, method = "IC", naturalGroupProp)
summary(result)



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