R/clean_name.R

In il.cbs.muni: Utility Functions to Work with Israeli Central Bureau of Statistics Municipal Data

#' Clean a string from characters unwanted in (mostly) yishuv names
#'
#' @param name a character vector
#'
#' @return a character vector without leading and trailing white space, and with
#' characters that are only letters and digits, excluding the following: `'-()\"`
#' @export
#'
#' @examples
#' clean_name("test-123_test*456")
#' x <- read_cbs_yishuv(system.file("extdata", "bycode2021.xlsx",
#'  package = "il.cbs.muni"))[[1]][c(153, 342)]
#' x
#' clean_name(x)
clean_name <- function(name) {
  # Validate input
  if (!is.character(name)) {
    rlang::abort(
      "`name` must be a character vector.",
      class = "clean_name_invalid_type"
    )
  }
  
  name |>
    stringr::str_remove_all("[[:punct:][:symbol:]&&[^'\\-()\"]]") |>
    stringr::str_squish()
}