enderecobr

Pacote de R para padronizar endereços brasileiros

https://github.com/ipeagit/enderecobr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.3%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

Pacote de R para padronizar endereços brasileiros

Basic Info

Host: GitHub
Owner: ipeaGIT
License: other
Language: R
Default Branch: main
Homepage: https://ipeagit.github.io/enderecobr/
Size: 2.5 MB

Statistics

Stars: 4
Watchers: 2
Forks: 2
Open Issues: 21
Releases: 6

Created over 2 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog License Codemeta

README.Rmd

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
```

# enderecobr 

[![CRAN
status](https://www.r-pkg.org/badges/version/enderecobr)](https://CRAN.R-project.org/package=enderecobr)
[![B
status](https://github.com/ipeaGIT/enderecobr/workflows/check/badge.svg)](https://github.com/ipeaGIT/enderecobr/actions?query=workflow%3Acheck)
[![CRAN/METACRAN Total
downloads](https://cranlogs.r-pkg.org/badges/grand-total/enderecobr?color=blue)](https://CRAN.R-project.org/package=enderecobr)
[![Codecov test
coverage](https://codecov.io/gh/ipeaGIT/enderecobr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ipeaGIT/enderecobr?branch=main)
[![Lifecycle:
stable](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](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 

**enderecobr** é desenvolvido por uma equipe de pesquisadores do Instituto
de Pesquisa Econômica Aplicada (Ipea).

Owner

Name: IpeaDIRUR
Login: ipeaGIT
Kind: organization

Repositories: 19
Profile: https://github.com/ipeaGIT

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "enderecobr",
  "description": "Padroniza endereos brasileiros a partir de diferentes critrios. Os mtodos de padronizao incluem apenas manipulaes bsicas de strings, no oferecendo suporte a correspondncias probabilsticas entre strings. (Standardizes brazilian addresses using different criteria. Standardization methods include only basic string manipulation, not supporting probabilistic matches between strings.)",
  "name": "enderecobr: Padronizador de Endereos Brasileiros (Brazilian Addresses\n    Standardizer)",
  "relatedLink": [
    "https://ipeagit.github.io/enderecobr/",
    "https://CRAN.R-project.org/package=enderecobr"
  ],
  "codeRepository": "https://github.com/ipeaGIT/enderecobr",
  "issueTracker": "https://github.com/ipeaGIT/enderecobr/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.4.1.9000",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.2 (2024-10-31 ucrt)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Daniel",
      "familyName": "Herszenhut",
      "email": "dhersz@gmail.com",
      "@id": "https://orcid.org/0000-0001-8066-1105"
    },
    {
      "@type": "Person",
      "givenName": "Rafael H. M.",
      "familyName": "Pereira",
      "@id": "https://orcid.org/0000-0003-2125-7465"
    },
    {
      "@type": "Person",
      "givenName": "Lucas",
      "familyName": "Mation",
      "@id": "https://orcid.org/0000-0002-7461-932X"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Daniel",
      "familyName": "Herszenhut",
      "email": "dhersz@gmail.com",
      "@id": "https://orcid.org/0000-0001-8066-1105"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 2.10"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "checkmate",
      "name": "checkmate",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=checkmate"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "data.table",
      "name": "data.table",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=data.table"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlang"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "stringi",
      "name": "stringi",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringi"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "stringr",
      "name": "stringr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringr"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    "SystemRequirements": null
  },
  "fileSize": "289.16KB",
  "releaseNotes": "https://github.com/ipeaGIT/enderecobr/blob/master/NEWS.md",
  "readme": "https://github.com/ipeaGIT/enderecobr/blob/main/README.md",
  "contIntegration": [
    "https://github.com/ipeaGIT/enderecobr/actions?query=workflow%3Acheck",
    "https://app.codecov.io/gh/ipeaGIT/enderecobr?branch=main"
  ],
  "developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html"
}

GitHub Events

Total

Create event: 7
Release event: 4
Issues event: 25
Watch event: 4
Issue comment event: 19
Push event: 41
Pull request event: 3
Fork event: 2

Last Year

Create event: 7
Release event: 4
Issues event: 25
Watch event: 4
Issue comment event: 19
Push event: 41
Pull request event: 3
Fork event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 47
Total pull requests: 3
Average time to close issues: about 1 month
Average time to close pull requests: N/A
Total issue authors: 4
Total pull request authors: 3
Average comments per issue: 1.62
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 26
Pull requests: 3
Average time to close issues: 3 days
Average time to close pull requests: N/A
Issue authors: 3
Pull request authors: 3
Average comments per issue: 1.46
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

dhersz (8)
rafapereirabr (7)
baarthur (2)
lucasmation (1)

Pull Request Authors

rafapereirabr (1)
PedroJorge7 (1)
BragatteMAS (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 465 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 5
Total maintainers: 1

cran.r-project.org: enderecobr

Padronizador de Endereços Brasileiros (Brazilian Addresses Standardizer)

Homepage: https://github.com/ipeaGIT/enderecobr
Documentation: http://cran.r-project.org/web/packages/enderecobr/enderecobr.pdf
License: MIT + file LICENSE
Latest release: 0.4.1
published over 1 year ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 465 Last month

Rankings

Dependent packages count: 27.9%

Dependent repos count: 34.4%

Average: 49.7%

Downloads: 86.9%

Maintainers (1)

dhersz@gmail.com

Last synced: 10 months ago

Dependencies

.github/workflows/check.yaml actions

actions/checkout v2 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

actions/checkout v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

DESCRIPTION cran

testthat >= 3.0.0 suggests

.github/workflows/rhub.yaml actions

r-hub/actions/checkout v1 composite
r-hub/actions/platform-info v1 composite
r-hub/actions/run-check v1 composite
r-hub/actions/setup v1 composite
r-hub/actions/setup-deps v1 composite
r-hub/actions/setup-r v1 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science