Skip to contents

ZIP Code Comparison

Source: R/cl_domain.R
cl_zip_code.Rd

A pre-built domain comparison for US ZIP codes. Provides levels for exact match, 5-digit prefix match (normalizes ZIP+4 against plain 5-digit codes), and 3-digit Sectional Center Facility (SCF) prefix match. Accepts both plain 5-digit ('90210') and ZIP+4 ('90210-3456') formats. Optionally appends geographic distance fallback levels when latitude and longitude columns are available.

Usage

cl_zip_code(
  term_frequency = FALSE,
  lat_col = NULL,
  long_col = NULL,
  km_thresholds = c(1, 10, 100)
)

Arguments

term_frequency

Logical. If TRUE, adjust match weights by ZIP code frequency at the highest comparison level. Defaults to FALSE.

lat_col, long_col

Character. Names of latitude and longitude columns. Both must be supplied together. When provided, geographic distance levels are appended before cl_else().

km_thresholds

Numeric vector of distance thresholds in kilometres, ordered from strictest to most lenient. Only used when lat_col and long_col are supplied. Defaults to c(1, 10, 100).

Value

A comparison-level object for use in il_compare().

Examples

il_spec() |>
  il_compare(zip, cl_zip_code())
#> Linkage Specification
#>   Comparisons (1):
#>     zip : levels
#>   Blocking rules: (none)

# With geographic fallback (requires lat/lon columns in the data)
il_spec() |>
  il_compare(zip, cl_zip_code(lat_col = 'lat', long_col = 'lon'))
#> Linkage Specification
#>   Comparisons (1):
#>     zip : levels
#>   Blocking rules: (none)