ChristianSGoncalves / cepR

Um pacote R para buscar informações sobre CEPs, endereços, bairros e cidades. (An R package for accessing Brazilian postal code data) :email:

cepR 🇧🇷

(English below)

cepR é um pacote para R que acessa dados postais do Brasil tais como nomes de bairros, cidades, estados, logradouros, CEPs e outras informações de interesse como altitude, longitude e latitude. Os dados são do projeto CEPaberto e para utilizar este pacote é preciso se cadastrar no site do CEPaberto e obter um token pessoal. Você pode contribuir para o projeto CEPaberto clicando na aba "Colaborar" do site. Para instalar o cepR é só seguir as instruções abaixo. Um banco de dados com endereços postais do estado de São Paulo está incluído no pacote e pode ser acessado com data("sp"). Sugestões, pull requests e comentários são muito bem-vindos!

Instalação

CRAN:

install.packages("cepR")

GitHub:

# install.packages("devtools")
devtools::install_github("RobertMyles/cepR")

Uso

É possível buscar os nomes das cidades e municipios com busca_estado()

library(cepR)
token <- "XXXXXXXXXXX" # seu token
sp <- busca_estado(estado = "SP", token = token)

sp
# A tibble: 863 x 2
   estado                  municipio
    <chr>                      <chr>
 1     SP                 Adamantina
 2     SP                     Adolfo
 3     SP         Agisse (Rancharia)
 4     SP                      Aguaí
 5     SP             Águas da Prata
 6     SP           Águas de Lindóia
 7     SP     Águas de Santa Bárbara
 8     SP         Águas de São Pedro
 9     SP Água Vermelha (São Carlos)
10     SP                     Agudos
# ... with 853 more rows

Pode-se também buscar os endereços por CEP. Por exemplo, o valor default do CEP é o da Praça de Sé:

> busca_cep(token = token)

# A tibble: 1 x 10
  estado    cidade bairro      cep              logradouro       latitude
   <chr>     <chr>  <chr>    <chr>                   <chr>          <chr>
1     SP São Paulo     Sé 01001000 Praça da Sé, lado ímpar -23.5479099981
# ... with 4 more variables: longitude <chr>, altitude <chr>, ddd <chr>,
#   cod_IBGE <chr>

Por fim, você pode buscar os logradouros de determinada cidade com busca_cidade().

Dados

O pacote vem com uma base de dados contendo endereços, nome de bairros e CEP do estado de São Paulo. Para carregá-la, digite data("sp"):

       cep                                                                   local bairro
     <chr>                                                                   <chr>  <chr>
1 01001000                                                 Praça da Sé, lado ímpar     Sé
2 01001001                                                   Praça da Sé, lado par     Sé
3 01001010                                                  Rua Filipe de Oliveira     Sé
4 01001900 UNESP - Universidade Estadual Júlio de Mesquita Filho, Praça da Sé, 108     Sé
5 01001901                                  Edifício Santa Lídia, Praça da Sé, 371     Sé
6 01001902                  OAB - Ordem dos Advogados do Brasil., Praça da Sé, 385     Sé
# ... with 4 more variables: id_cidade <int>, id_estado <int>, cidade <chr>, estado <chr>

cepR 🇬🇧

cepR is a package for accessing Brazilian address data: neighbourhood names, city and state names, actual addresses, postal codes, and other info such as altitude, longitude & latitude. The data come from the CEPaberto project, and to use the package, you'll need a personal access token from the CEP Aberto site. Suggestions, pull requests, criticisms all welcome. You can install the package as shown in Instalação above. A dataset of address data for the state of São Paulo comes with the package and is accessible with data("sp"). The package is aimed at a Brazilian audience, so if you don't speak Portuguese:

• bairro = neighbourhood;
• cep = postal code;
• logadouro = address;
• município = municipality.

The others aren't too hard to figure out 🐵.