diff --git a/index.html b/index.html index ce74176..71419ba 100644 --- a/index.html +++ b/index.html @@ -82,6 +82,61 @@

Instalação# install.packages("remotes") remotes::install_github("ipeaGIT/enderecopadrao") +
+

Utilização +

+

O pacote atualmente fornece funções para padronizar diferentes campos de um endereço. São elas:

+ +

Cada uma dessas funções recebe um vetor com valores não padronizados e retorna um vetor de mesmo tamanho com os respectivos valores padronizados.

+

A padronizar_estados() aceita vetores de caracteres e números. Caso numérico, o vetor deve conter o código do IBGE de cada estado. Caso seja composto de caracteres, o vetor pode conter a sigla do estado, seu código ou seu nome por extenso. Neste caso, a função ainda aplica diversas manipulações para chegar a um valor padronizado, como a conversão de caracteres para caixa alta, remoção de acentos e caracteres não ASCII e remoção de espaços em branco antes e depois dos valores e de espaços em excesso entre palavras. O código abaixo apresenta exemplos de aplicação da função com vetores numéricos e de caracteres.

+
+library(enderecopadrao)
+
+estados <- c("21", " 21", "MA", " MA ", "ma", "MARANHÃO")
+padronizar_estados(estados)
+#> [1] "MARANHAO" "MARANHAO" "MARANHAO" "MARANHAO" "MARANHAO" "MARANHAO"
+
+estados <- c(21, 32)
+padronizar_estados(estados)
+#> [1] "MARANHAO"       "ESPIRITO SANTO"
+

A padronizar_municipios() funciona de forma muito semelhante, aceitando também valores numéricos representando os códigos dos municípios e valores numéricos. As mesmas manipulações de remoção de espaços, conversão para caixa alta são aplicadas e conversão para caracteres são aplicadas (assim como nos demais tratamentos de vetores de caracteres que serão apresentados a seguir), mas a função também verifica erros ortográficos frequentemente observados nos nomes dos municípios (e.g. Moji Mirim -> Mogi Mirim, Parati -> Paraty).

+
+municipios <- c(
+  "3304557", "003304557", " 3304557 ", "RIO DE JANEIRO", "rio de janeiro",
+  "SÃO PAULO"
+)
+padronizar_municipios(municipios)
+#> [1] "RIO DE JANEIRO" "RIO DE JANEIRO" "RIO DE JANEIRO" "RIO DE JANEIRO"
+#> [5] "RIO DE JANEIRO" "SAO PAULO"
+
+municipios <- 3304557
+padronizar_municipios(municipios)
+#> [1] "RIO DE JANEIRO"
+
+municipios <- c("PARATI", "MOJI MIRIM")
+padronizar_municipios(municipios)
+#> [1] "PARATY"     "MOGI MIRIM"
+

A padronizar_bairros() trabalha exclusivamente com vetores de caracteres. Como os nomes de bairros são muito mais variados e, consequentemente, menos rigidamente controlados do que os de estados e municípios, a função se atém a corrigir erros ortográficos e a expandir abreviações frequentemente utilizadas através de diversas expressões regulares (regexes). O exemplo abaixo mostra algumas das muitas abreviações usualmente empregadas no preenchimento de endereços.

+
+bairros <- c(
+  "PRQ IND",
+  "NSA SEN DE FATIMA",
+  "ILHA DO GOV",
+  "VL OLIMPICA",
+  "NUC RES"
+)
+padronizar_bairros(bairros)
+#> [1] "PARQUE INDUSTRIAL"       "NOSSA SENHORA DE FATIMA"
+#> [3] "ILHA DO GOVERNADOR"      "VILA OLIMPICA"          
+#> [5] "NUCLEO RESIDENCIAL"
+
diff --git a/pkgdown.yml b/pkgdown.yml index e606f7e..543d253 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.11 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2024-03-19T19:05Z +last_built: 2024-03-19T21:17Z diff --git a/reference/padronizar_logradouros.html b/reference/padronizar_logradouros.html index 6518d51..337ab0a 100644 --- a/reference/padronizar_logradouros.html +++ b/reference/padronizar_logradouros.html @@ -43,7 +43,7 @@
diff --git a/reference/padronizar_municipios.html b/reference/padronizar_municipios.html index 1b2d5c4..66083df 100644 --- a/reference/padronizar_municipios.html +++ b/reference/padronizar_municipios.html @@ -96,9 +96,9 @@

Examples

#> [1] "RIO DE JANEIRO" "RIO DE JANEIRO" "RIO DE JANEIRO" "RIO DE JANEIRO" #> [5] "RIO DE JANEIRO" "SAO PAULO" "" "" -municipios <- c(21, NA) +municipios <- c(3304557, NA) padronizar_municipios(municipios) -#> [1] "21" "" +#> [1] "RIO DE JANEIRO" "" municipios <- c("PARATI", "AUGUSTO SEVERO", "SAO VALERIO DA NATIVIDADE") padronizar_municipios(municipios)