bal.tab.mimids: Balance Statistics for `MatchThem` Objects

Description

Generates balance statistics for mimids and wimids objects from MatchThem.

Usage

# S3 method for mimids
bal.tab(x, 
        stats,
        int = FALSE,
        poly = 1,
        distance = NULL,
        addl = NULL,
        data = NULL,
        continuous,
        binary,
        s.d.denom,
        thresholds = NULL,
        weights = NULL,
        cluster = NULL,
        pairwise = TRUE,
        s.weights = NULL,
        abs = FALSE,
        subset = NULL,
        quick = TRUE,
        ...)

Value

If clusters are not specified, an object of class "bal.tab.imp" containing balance summaries for each imputation and a summary of balance across imputations. See bal.tab.imp for details.

If clusters are specified, an object of class "bal.tab.imp.cluster" containing summaries between and across all clusters and imputations.

Arguments

x

a mimids or wimids object; the output of a call to MatchThem::matchthem() or MatchThem::weightthem().

stats, int, poly, addl, data, continuous, binary, thresholds, weights, cluster, pairwise, s.weights, abs, subset, quick, ...

see bal.tab() for details.

See below for special notes on the distance, s.d.denom, and imp arguments. Note the imp argument is ignored because the imputation identifers are already present in the input object.

The following arguments have special notes when used with mimids and wimids objects:

distance: the distance measure generated by matchthem() or weightthem() is automatically included and named "distance" or "prop.score", respectively.
s.d.denom: the defaults depend on the options specified in the original function calls; see bal.tab.matchit() and bal.tab.weightit() for details on the defaults.

Author

Noah Greifer

Details

bal.tab.mimids() and bal.tab.wimids() generate a list of balance summaries for the mimids or wimids object given.

State of Data and AI Literacy Report 2025