overview: Overview of matching quality

overviewR Documentation

Overview of matching quality

Description

The overview function provides a quick assessment of overall matching quality by reporting the N, mean, and s.d. of focal, matched, pool, and unmatched sets for all covariates as well as the propensity scores ('ps'). The mean and s.d. difference in focal - matched is also reported.

Usage

overview(x, digits = 2, ...)

## S4 method for signature 'Matched,numeric_OR_missing'
overview(x, digits)

Arguments

x

Matched object

digits

Integer indicating the number of significant digits to be used. Negative values are allowed (see ?signif).

...

Additional arguments.

Details

Factor, character, or logical covariates are reported by N per set, rather than with mean and s.d.

Value

  • A printed overview of matching quality.

  • (Internally) a MatchedOverview object.

Examples

set.seed(123)
mdf <- makeExampleMatchedDataSet(matched = TRUE)
overview(mdf)


nullranges/nullranges documentation built on Aug. 29, 2023, 12:13 a.m.