Merge branch 'main' of https://github.com/ipeaGIT/geocodebr

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: geocodebr
 Title: Geolocalização de Endereços Brasileiros
-Version: 0.0.0.9001
+Version: 0.0.0.9002
 Authors@R: c(
     person("Daniel", "Herszenhut", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-8066-1105")),

NAMESPACE

@@ -1,10 +1,10 @@
 # Generated by roxygen2: do not edit by hand
 
+export(definir_campos)
 export(definir_pasta_cache)
 export(deletar_pasta_cache)
 export(download_cnefe)
 export(geocode)
-export(listar_campos)
 export(listar_dados_cache)
 export(listar_pasta_cache)
 importFrom(data.table,"%chin%")

R/listar_campos.R → R/definir_campos.R

@@ -33,7 +33,7 @@
 #'   valores são as colunas que os representam na tabela de endereços.
 #'
 #' @examples
-#' listar_campos(
+#' definir_campos(
 #'   logradouro = "Nome_logradouro",
 #'   numero = "Numero",
 #'   cep = "CEP",
@@ -43,7 +43,7 @@
 #' )
 #'
 #' @export
-listar_campos <- function(estado,
+definir_campos <- function(estado,
                           municipio,
                           logradouro = NULL,
                           numero = NULL,

R/geocode.R

@@ -11,7 +11,7 @@
 #'    coluna deve representar um campo do endereço.
 #' @param campos_endereco Um vetor de caracteres. A correspondência entre cada
 #'    campo de endereço e o nome da coluna que o descreve na tabela `enderecos`.
-#'    A função [listar_campos()] auxilia na criação deste vetor e realiza
+#'    A função [definir_campos()] auxilia na criação deste vetor e realiza
 #'    algumas verificações nos dados de entrada. Campos de endereço passados
 #'    como `NULL` serão ignorados, e a função deve receber pelo menos um campo
 #'    não nulo, além  dos campos `"estado"` e `"municipio"`, que são
@@ -39,7 +39,7 @@
 #' data_path <- system.file("extdata/small_sample.csv", package = "geocodebr")
 #' input_df <- read.csv(data_path)
 #'
-#' fields <- geocodebr::listar_campos(
+#' fields <- geocodebr::definir_campos(
 #'   logradouro = "nm_logradouro",
 #'   numero = "Numero",
 #'   cep = "Cep",
@@ -58,7 +58,7 @@
 #'
 #' @export
 geocode <- function(enderecos,
-                    campos_endereco = listar_campos(),
+                    campos_endereco = definir_campos(),
                     resultado_completo = FALSE,
                     resultado_sf = FALSE,
                     verboso = TRUE,

README.Rmd

@@ -42,7 +42,7 @@ remotes::install_github("ipeaGIT/geocodebr")
 
 Uma que você possui uma tabela de dados (`data.frame`) com endereços no Brasil, a geolocalização desses dados com **{geocodebr}** pode ser feita em apenas dois passos:
 
-1. O primeiro passo é usar a função `listar_campos()` para indicar os nomes das colunas no seu `data.frame` que correspondem a cada campo dos endereços.
+1. O primeiro passo é usar a função `definir_campos()` para indicar os nomes das colunas no seu `data.frame` que correspondem a cada campo dos endereços.
 
 2. O segundo passo é usar a função `geocode()` para encontrar as coordenadas geográficas dos endereços de input.
 
@@ -54,7 +54,7 @@ library(geocodebr)
 input_df <- read.csv(system.file("extdata/small_sample.csv", package = "geocodebr"))
 
 # Primeiro passo: inidicar o nome das colunas com cada campo dos enderecos
-campos <- geocodebr::listar_campos(
+campos <- geocodebr::definir_campos(
   logradouro = "nm_logradouro",
   numero = "Numero",
   cep = "Cep",

README.md

@@ -39,7 +39,7 @@ Uma que você possui uma tabela de dados (`data.frame`) com endereços no
 Brasil, a geolocalização desses dados com **{geocodebr}** pode ser feita
 em apenas dois passos:
 
-1.  O primeiro passo é usar a função `listar_campos()` para indicar os
+1.  O primeiro passo é usar a função `definir_campos()` para indicar os
     nomes das colunas no seu `data.frame` que correspondem a cada campo
     dos endereços.
 
@@ -53,7 +53,7 @@ library(geocodebr)
 input_df <- read.csv(system.file("extdata/small_sample.csv", package = "geocodebr"))
 
 # Primeiro passo: inidicar o nome das colunas com cada campo dos enderecos
-campos <- geocodebr::listar_campos(
+campos <- geocodebr::definir_campos(
   logradouro = "nm_logradouro",
   numero = "Numero",
   cep = "Cep",

tests/tests_rafa/benchmark_LIKE.R

@@ -68,7 +68,7 @@ input_df <- arrow::read_parquet(data_path)
 # cache = TRUE
 # resultado_completo = T
 # resultado_sf = F
-# campos_endereco <- geocodebr::listar_campos(
+# campos_endereco <- geocodebr::definir_campos(
 #   logradouro = 'logradouro',
 #   numero = 'numero',
 #   cep = 'cep',
@@ -83,7 +83,7 @@ ncores <- 7
 
 
 
-campos <- geocodebr::listar_campos(
+campos <- geocodebr::definir_campos(
   logradouro = 'logradouro',
   numero = 'numero',
   cep = 'cep',
@@ -222,7 +222,7 @@ input_df <- read.csv(data_path, encoding = 'Latin-1')
 
 
 
-campos <- geocodebr::listar_campos(
+campos <- geocodebr::definir_campos(
   logradouro = 'nm_logradouro',
   numero = 'Numero',
   cep = 'Cep',

tests/tests_rafa/benchmark_reg_adm.R

@@ -58,7 +58,7 @@ data.table::setnames(
 head(rais)
 
 
-fields <- geocodebr::setup_address_fields(
+fields <- geocodebr::definir_campos(
   logradouro = 'logradouro_no_numbers',
   numero = 'numero',
   cep = 'cep',

tests/testthat/_snaps/listar_campos.md → tests/testthat/_snaps/definir_campos.md

@@ -3,6 +3,6 @@
     Code
       tester()
     Condition <geocodebr_error_null_address_fields>
-      Error in `listar_campos()`:
+      Error in `definir_campos()`:
       ! Pelo menos um campo não pode ser nulo `NULL`.
 

tests/testthat/test-listar_campos.R → tests/testthat/test-definir_campos.R

@@ -4,7 +4,7 @@ tester <- function(logradouro = NULL,
                    localidade = NULL,
                    municipio = NULL,
                    estado = NULL) {
-  listar_campos(
+  definir_campos(
     logradouro,
     numero,
     cep,

tests/testthat/test-geocode.R

@@ -1,7 +1,7 @@
 data_path <- system.file("extdata/small_sample.csv", package = "geocodebr")
 input_df <- read.csv(data_path)
 
-campos <- listar_campos(
+campos <- definir_campos(
   logradouro = "nm_logradouro",
   numero = "Numero",
   cep = "Cep",

vignettes/geocodebr.Rmd

@@ -67,7 +67,7 @@ library(geocodebr)
 
 ends <- read.csv(system.file("extdata/small_sample.csv", package = "geocodebr"))
 
-campos <- listar_campos(
+campos <- definir_campos(
   estado = "nm_uf",
   municipio = "nm_municipio",
   logradouro = "nm_logradouro",
@@ -81,13 +81,13 @@ ends_geo <- geocode(ends, campos_endereco = campos, verboso = FALSE)
 head(ends_geo)
 ```
 
-Note que no exemplo acima nós também utilizamos a função `listar_campos()`, que
+Note que no exemplo acima nós também utilizamos a função `definir_campos()`, que
 facilita o processo de especificação da correspondência entre as colunas da
 tabela e os campos esperados de cada endereço. Com ela, nós definimos que a
 coluna que contém a informação de logradouro se chama `"nm_logradouro"`, que a
 coluna de número se chama `"Numero"`, etc. Essa função é opcional, e poderíamos
 simplesmente passar um vetor de caracteres no formato `c(logradouro =
-"nm_logradouro", numero = "Numero", ...)`. A `listar_campos()`, no entanto,
+"nm_logradouro", numero = "Numero", ...)`. A `definir_campos()`, no entanto,
 realiza alguns testes nas colunas e na tabela, garantindo que o *input* passado
 esteja corretamente formatado.
 

vignettes/geocoding_pt.Rmd

@@ -24,7 +24,7 @@ knitr::opts_chunk$set(
 
 Uma vez que você tenha uma tabela (`data.frame`) com endereços, a geolocalização dos dados com **{geocodebr}** pode ser feita em dois passos simples:
 
-1. O primeiro passo é utilizar a função `listar_campos()` para declarar os nomes das colunas no seu `data.frame` que correspondem a cada campo dos endereços.
+1. O primeiro passo é utilizar a função `definir_campos()` para declarar os nomes das colunas no seu `data.frame` que correspondem a cada campo dos endereços.
 
 
 ```{r, eval=TRUE}
@@ -34,7 +34,7 @@ library(geocodebr)
 input_df <- read.csv(system.file("extdata/small_sample.csv", package = "geocodebr"))
 
 # 1o passo: indicar nome das colunas correspondento aos campos de endereço
-fields <- geocodebr::listar_campos(
+fields <- geocodebr::definir_campos(
   logradouro = "nm_logradouro",
   numero = "Numero",
   cep = "Cep",