dot-overall_balance: Summarise a per-variable balance table

.overall_balanceR Documentation

Summarise a per-variable balance table

Description

The three headline numbers every balance object reports, read off the per-variable table each of them builds.

Usage

.overall_balance(var_stats, n_vars)

Arguments

var_stats

A per-variable balance table, as calculate_var_balance() rows bound together.

n_vars

How many variables the balance was asked about. This is the number asked for rather than nrow(var_stats), which is smaller when a variable produced no statistics.

Value

List with mean_abs_std_diff, max_abs_std_diff, pct_large_imbalance and n_vars.


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