-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
151 lines (120 loc) · 4.52 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# enderecobr <img align="right" src="man/figures/logo.svg" alt="" width="180">
[](https://CRAN.R-project.org/package=enderecobr)
[](https://github.com/ipeaGIT/enderecobr/actions?query=workflow%3Acheck)
[](https://CRAN.R-project.org/package=enderecobr)
[](https://app.codecov.io/gh/ipeaGIT/enderecobr?branch=main)
[](https://lifecycle.r-lib.org/articles/stages.html)
**enderecobr** é um pacote de R que permite padronizar endereços brasileiros
a partir de diferentes critérios. Os métodos de padronização atualmente incluem
apenas manipulações de strings, não oferecendo suporte a correspondências
probabilísticas entre strings.
## Instalação
A última versão estável pode ser baixada do CRAN com o comando a seguir:
```r
install.packages("enderecobr")
```
Caso prefira, a versão em desenvolvimento também pode ser usada. Para isso, use
o seguinte comando:
```r
# install.packages("remotes")
remotes::install_github("ipeaGIT/enderecobr")
```
## Utilização
Esta seção visa oferecer apenas uma visão geral das funcionalidades do pacote.
Para mais detalhes, leia a vignette introdutória:
- [**enderecobr**: padronizador de endereços
brasileiros](https://ipeagit.github.io/enderecobr/articles/enderecobr.html)
O **enderecobr** disponibiliza funções para padronizar diferentes campos de um
endereço. A `padronizar_enderecos()`, carro-chefe do pacote, atua de forma
simultânea sobre os vários campos que podem compor um endereço. Para isso, ela
recebe um dataframe e a correspondência entre suas colunas e os campos a serem
padronizados:
```{r}
library(enderecobr)
enderecos <- data.frame(
logradouro = "r ns sra da piedade",
nroLogradouro = 20,
complemento = "qd 20",
cep = 25220020,
bairro = "jd botanico",
codmun_dom = 3304557,
uf_dom = "rj"
)
campos <- correspondencia_campos(
logradouro = "logradouro",
numero = "nroLogradouro",
complemento = "complemento",
cep = "cep",
bairro = "bairro",
municipio = "codmun_dom",
estado = "uf_dom"
)
padronizar_enderecos(enderecos, campos_do_endereco = campos)
```
Por trás dos panos, essa função utiliza diversas outras funções que padronizam
campos de forma individual. Cada uma delas recebe um vetor com valores não
padronizados e retorna um vetor de mesmo tamanho com os respectivos valores
padronizados. Algumas das funções disponíveis são apresentadas a seguir:
```{r}
estados <- c("21", " 21", "MA", " MA ", "ma", "MARANHÃO")
padronizar_estados(estados)
municipios <- c(
"3304557", "003304557", " 3304557 ", "RIO DE JANEIRO", "rio de janeiro",
"SÃO PAULO"
)
padronizar_municipios(municipios)
bairros <- c(
"PRQ IND",
"NSA SEN DE FATIMA",
"ILHA DO GOV",
"VL OLIMPICA",
"NUC RES"
)
padronizar_bairros(bairros)
ceps <- c("22290-140", "22.290-140", "22290 140", "22290140")
padronizar_ceps(ceps)
logradouros <- c(
"r. gen.. glicério, 137",
"cond pres j. k., qd 05 lt 02 1",
"av d pedro I, 020"
)
padronizar_logradouros(logradouros)
numeros <- c("0210", "001", "1", "", "S N", "S/N", "SN", "0180 0181")
padronizar_numeros(numeros)
```
## Controle de verbosidade
O disparo de mensagens com informações sobre a execução das funções pode ser
controlado pela opção `enderecobr.verbose`, que recebe os valores `"quiet"` ou
`"verbose"`, como demonstrado a seguir:
```r
campos <- correspondencia_logradouro(
nome_do_logradouro = "logradouro",
numero = "nroLogradouro"
)
# quieto, por padrão
res <- padronizar_logradouros_completos(enderecos, campos)
# verboso, se desejado
rlang::local_options("enderecobr.verbose" = "verbose")
res <- padronizar_logradouros_completos(enderecos, campos)
#> ✔ Padronizando nomes dos logradouros... [130ms]
#> ✔ Padronizando números... [111ms]
#> ✔ Trazendo números para o logradouro completo... [107ms]
```
## Nota <a href="https://www.ipea.gov.br"><img src="man/figures/ipea_logo.png" alt="Ipea" align="right" width="300"/></a>
**enderecobr** é desenvolvido por uma equipe de pesquisadores do Instituto
de Pesquisa Econômica Aplicada (Ipea).