Summarise Validation Results — make_validation

Creates a human-readable summary describing how closely a synthetic population matches reference distributions.

Usage

make_validation_line(
  validation_results_ls,
  what_1L_chr,
  digits_1L_int = 2,
  threshold_1L_dbl = 1
)

Arguments

validation_results_ls: A list of validation results, typically generated by procure().
what_1L_chr: Name of the attribute being validated.
digits_1L_int: Number of decimal places to display. Defaults to 2.
threshold_1L_dbl: Maximum acceptable percentage difference. Defaults to 1.

Value

A character string summarising validation performance.

Details

The summary reports the percentage of assignment groups whose relative difference from source data is below a specified threshold.

The reported percentage is based on the proportion of assignment groups whose percentage difference from the source distribution does not exceed threshold_1L_dbl.

Examples

if (FALSE) { # \dontrun{
make_validation_line(
  validation_results_ls,
  what_1L_chr = "Urbanicity"
)
} # }