---
title: "nomesbr"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{nomesbr}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```
## nomesbr

**nomesbr** é um pacote de R que limpa e simplifica nomes de pessoas para 
auxiliar no pareamento de banco de dados na ausência de chaves únicas não 
ambíguas. Detecta e corrige erros tipográficos mais comuns, simplifica 
opcionalmente termos sujeitos eventualmente a omissão em cadastros, e 
simplifica . 

(R package for tidying and simplifying. Created for aiding in dataset pairing in 
the absence of unambiguous keys.
It detects and corrects common typos, optionally simplifies terms prone 
to omission in records.)

```{r setup}
library(nomesbr)
```

## Utilização

O pacote **nomesbr** torna disponíveis funções para limpar e simplificar nomes.
 `limpar_nomes()` e `simplifica_PARTICULAS_AGNOMES_PATENTES`, principais funções 
 do pacote, foram criadas para seu uso em sequência nessa ordem.

`limpar_nomes()` recebe como parâmetros d,um data.frame, e s, nome da coluna 
com os nomes a processar. A função cria uma nova coluna, com sufixo '_clean', e gera 
novas colunas com informações dos tipos de limpeza detectados 
como necessários e realizados.

`simplifica_PARTICULAS_AGNOMES_PATENTES()` recebe também, d e s (por padrão para s, 'nome_clean')
 como parâmetros, e simplifica partículas repetidas, agnomes e alguma patentes.  
 
 A informação (novas colunas) gerada pela função `limpar_nomes()` servem como base 
 para a função `tabular_problemas_em_nomes()` , que retorna uma tabela resumo 
 dos problemas detectados e ações tomadas no sentido da limpeza de nomes.

## Nota <a href="https://www.ipea.gov.br"><img src="man/figures/ipea_logo.png" alt="Ipea" align="right" width="300"/></a>

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