R/tidy_single_line_address.R

In nhsbsa-data-analytics/addressMatchR: This package matches address

#' Tidy a lazy_table single line address
#'
#' Tidy a single line address ready for tokenising.
#'
#' @param df Must be  lazy_table (i.e. not a data frame)
#' @param col Single line address column
#' @param remove_postcode If to remove the postcode. Default is FALSE
#'
#' @examples
#' @export
#'
tidy_single_line_address <- function(df, col, remove_postcode = FALSE) {

  # Remove postcode from single line address if necessary (e.g. after last ",")
  if (remove_postcode) {
    # Process as lazy table
    df <- df %>%
      dplyr::mutate({{ col }} := REGEXP_REPLACE({{ col }}, "[,][^,]+$", ""))
  }

  # Process as a lazy frame
  df %>%
    dplyr::mutate(
      {{ col }} := trimws(REGEXP_REPLACE(REGEXP_REPLACE(REPLACE(REGEXP_REPLACE(REGEXP_REPLACE(REGEXP_REPLACE(REGEXP_REPLACE(toupper({{ col }}),                          # Uppercase
                                                                                                                                    "([A-Za-z])''([A-Za-z])", '\\1\\2'), # replace apostrophe between letters
                                                                                                                                    "[,.();:#'']", " "),                 # replace special characters with a single space
                                                                                                                                    "(\\d)(\\D)", "\\1 \\2"),            # add a space between any digit followed by a non-digit (e.g. 1A becomes 1 A)
                                                                                                                                    "(\\D)(\\d)", "\\1 \\2"),            # add a space between any non-digit followed by a digit (e.g. A1 becomes A 1)
                                                                                                                                    "&", " AND "),                       # replace the ampersand character with the string "and"
                                                                                                                                    "\\s+", " "),                        # replace any multiple spaces with a single space
                                                                                                                                    "([0-9]) - ([0-9])", "\\1-\\2"))     # reconnect numbers separated by a hyphen
    )
}