bal.tab.matching_result: Balance Table for Matching Results (cobalt integration)

In couplr: Optimal Pairing and Matching via Linear Assignment

Balance Table for Matching Results (cobalt integration)

Description

S3 method enabling cobalt::bal.tab() on couplr result objects. Requires the cobalt package to be installed.

Usage

## S3 method for class 'matching_result'
bal.tab(x, left, right, ...)

## S3 method for class 'full_matching_result'
bal.tab(x, left, right, ...)

## S3 method for class 'cem_result'
bal.tab(x, left, right, ...)

## S3 method for class 'subclass_result'
bal.tab(x, data = NULL, ...)

Arguments

x	A couplr result object
left	Data frame of left (treated) units
right	Data frame of right (control) units
...	Additional arguments. Arguments named in as_matchit()'s signature go to the conversion; the rest go to cobalt::bal.tab().
data	Data frame used for subclassification (for subclass_result only)

Details

These methods convert couplr results to the format cobalt expects (a matchit-class object) and then delegate to cobalt's own bal.tab.matchit() method. The cobalt package must be installed but is not required for couplr to function.

Value

A cobalt balance table object

couplr documentation built on Sept. 17, 2026, 1:08 a.m.