hcodes: Create codes to identify each unique combination of...

In epicentre-msf/hmatch: Tools for Cleaning and Matching Hierarchically-Structured Data

Create codes to identify each unique combination of hierarchical levels in a reference dataset

Description

Create codes to identify each unique combination of hierarchical levels in a reference dataset. Codes may be integer-based (function hcodes_int) or string-based (hcodes_str). Integer-based codes reflect the alphabetical ranking of each level within the next-highest level. They are constant-width and may optionally be prefixed with any given string. String-based codes are created by pasting together the values of each hierarchical level with a given separator (with options for string standardization prior to collapsing).

Usage

hcodes_str(ref, pattern, by, sep = "__", std_fn = string_std)

hcodes_int(ref, pattern, by, prefix = "")

Arguments

ref	data.frame containing hierarchical columns with reference data
pattern	regex pattern to match the names of the hierarchical columns in ref (supply either pattern or by)
by	vector giving the names of the hierarchical columns in ref (supply either pattern or by)
sep	(only for hcodes_str) desired separator between levels in string-based codes (defaults to "__")
std_fn	(only for hcodes_str) Function to standardize input strings prior to creating codes. Defaults to string_std. Set to NULL to omit standardization. See also string_standardization.
prefix	(only for hcodes_int) character prefix for integer-based codes (defaults to "")

Value

A vector of codes

Examples

data(ne_ref)

# string-based codes
hcodes_str(ne_ref, pattern = "^adm")

# integer-based codes
hcodes_int(ne_ref, pattern = "^adm")

epicentre-msf/hmatch documentation built on Nov. 15, 2023, 1:47 a.m.