R/correspondencia_logradouro.R

In enderecobr: Padronizador de Endereços Brasileiros (Brazilian Addresses Standardizer)

#' Correspondência entre os campos do logradouro completo e as colunas que os
#' descrevem
#'
#' Cria um vetor de caracteres que especifica as colunas que representam os
#' campos de logradouro (tipo, nome e número) em um dataframe de endereços.
#'
#' @param tipo_de_logradouro,nome_do_logradouro,numero Uma string. O nome da
#'   coluna que representa o respectivo campo do logradouro no dataframe. Pode
#'   ser `NULL`, no caso do campo não estar listado. Ao menos um dos campos deve
#'   receber um valor não nulo.
#'
#' @return Um vetor nomeado de caracteres, em que os nomes representam os campos
#'   do logradouro e os valores as colunas que os descrevem no dataframe.
#'
#' @examples
#' enderecos <- data.frame(
#'   tipo = "r",
#'   log = "ns sra da piedade",
#'   nroLogradouro = 20
#' )
#'
#' # dado o dataframe acima, a seguinte chamada cria a correspondencia entre
#' # suas colunas e os campos
#' correspondencia_logradouro(
#'   tipo_de_logradouro = "tipo",
#'   nome_do_logradouro = "log",
#'   numero = "nroLogradouro"
#' )
#'
#' @export
correspondencia_logradouro <- function(tipo_de_logradouro = NULL,
                                       nome_do_logradouro = NULL,
                                       numero = NULL) {
  col <- checkmate::makeAssertCollection()
  checkmate::assert_string(tipo_de_logradouro, null.ok = TRUE, add = col)
  checkmate::assert_string(nome_do_logradouro, null.ok = TRUE, add = col)
  checkmate::assert_string(numero, null.ok = TRUE, add = col)
  checkmate::reportAssertions(col)

  vetor_correspondencia <- c(
    tipo_de_logradouro = tipo_de_logradouro,
    nome_do_logradouro = nome_do_logradouro,
    numero = numero
  )

  if (is.null(vetor_correspondencia)) erro_correspondencia_logradouro_nula()

  return(vetor_correspondencia)
}

erro_correspondencia_logradouro_nula <- function() {
  erro_endbr(
    paste0(
      "Ao menos um dos argumentos da {.fn correspondencia_logradouro} ",
      "deve ser diferente de {.code NULL}."
    ),
    call = rlang::caller_env()
  )
}