-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
103 lines (68 loc) · 4.86 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# geocodebr: Geolocalização de Endereços Brasileiros
[](https://CRAN.R-project.org/package=geocodebr)
[](https://github.com/ipeaGIT/geocodebr/actions)
[](https://app.codecov.io/gh/ipeaGIT/geocodebr?branch=main)
[](https://lifecycle.r-lib.org/articles/stages.html)
O **{geocodebr}** é um pacote computacional para geolicalização de endereços Brasileiros. O pacote oferece uma maneira simples e eficiente de geolicalizar endereços para encontrar suas coordenadas geográficas. O pacote é baseado em conjuntos de dados espaciais abertos de endereços brasileiros, utilizando principalmente o Cadastro Nacional de Endereços para Fins Estatísticos (CNEFE). O CNEFE é
[publicado](https://www.ibge.gov.br/estatisticas/sociais/populacao/38734-cadastro-nacional-de-enderecos-para-fins-estatisticos.html) pelo Instituto Brasileiro de Geografia e Estatística (IBGE). Atualmente, o pacote está disponível apenas em R.
## Instalação
O pacote ainda não está disponível no CRAN. Você pode instalar a versão em desenvolvimento com o código abaixo:
```r
# install.packages("remotes")
remotes::install_github("ipeaGIT/geocodebr")
```
## Utilização
### Geolocalização: de endereços para coordenadas espaciais
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 `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.
```{r, eval=FALSE}
library(geocodebr)
# carregando uma amostra de dados
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::definir_campos(
logradouro = "nm_logradouro",
numero = "Numero",
cep = "Cep",
localidade = "Bairro",
municipio = "nm_municipio",
estado = "nm_uf"
)
# Segundo passo: geolocalizar
df <- geocodebr::geocode(
enderecos = input_df,
campos_endereco = campos,
resultado_completo = FALSE,
verboso = FALSE,
cache = TRUE,
n_cores = 1
)
```
Os resultados do **{geocodebr}** são classificados em seis categorias gerais de `precisao`, dependendo do nível de exatidão com que cada endereço de input foi encontrado nos dados do CNEFE. Para mais informações, consulte a documentação da função ou a **vignette de geocode**.
### Geocode reverso: de coordenadas espaciais para endereços
*em breve*
## Projetos relacionados
Existem diversos pacotes de geolocalização disponíveis, muitos dos quais podem ser utilizados em R (listados abaixo). A maioria dessas alternativas depende de softwares e conjuntos de dados comerciais, geralmente impondo limites de número de consultas gratuitas. Em contraste, as principais vantagens do **{geocodebr}** são que o pacote: (a) é completamente gratuito, permitindo consultas ilimitadas sem nenhum custo; (b) opera com alta velocidade e escalabilidade eficiente, permitindo geocodificar milhões de endereços em apenas alguns minutos, sem a necessidade de infraestrutura computacional avançada ou de alto desempenho.
- [{arcgisgeocode}](https://cran.r-project.org/web/packages/arcgisgeocode/index.html) and [{arcgeocoder}](https://cran.r-project.org/web/packages/arcgeocoder/index.html): utiliza serviço de geocode do ArcGIS
- [{nominatimlite}](https://cran.r-project.org/web/packages/nominatimlite/index.html): baseado dados do OSM
- [{photon}](https://cran.r-project.org/web/packages/photon/index.html): baseado dados do OSM
- [{tidygeocoder}](https://cran.r-project.org/web/packages/tidygeocoder/index.html): API para diversos servicos de geolocalização
- [{googleway}](https://cran.r-project.org/web/packages/googleway/index.html) and [{mapsapi}](https://cran.r-project.org/web/packages/mapsapi/index.html): interface para API do Google Maps
## Nota <a href="https://www.ipea.gov.br"><img src="man/figures/ipea_logo.png" alt="IPEA" align="right" width="300"/></a>
Os dados originais do CNEFE são coletados pelo Instituto Brasileiro de Geografia e Estatística (IBGE). O **{geocodebr}** foi desenvolvido por uma equipe do Instituto de Pesquisa Econômica Aplicada (Ipea)