README.Rmd

---
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%"
)
```

# eleicoesmun2020

<!-- badges: start -->
<!-- badges: end -->

Uma forma mais fácil de ler os dados simplificados das eleições municipais de 2020 do TSE.
Os dados são puxados diretamente da API do TSE. 

O pacote foi feito com ajuda do código do [Marco Antonio Faganello](https://github.com/marcofaga/eleicoes2020).

## Instalação

Para instalar o pacote:

``` r
# install.packages("devtools")
devtools::install_github("rmhirota/eleicoesmun2020")
```
## Exemplo

Baixando dados de eleições à prefeitura em Roraima:

```{r example1}
library(eleicoesmun2020)

download_uf(estado = "RR", cargo = "prefeito", path = "csv")
```

A função retornará uma tabela com os dados, além de salvar um arquivo .csv na pasta indicada em ```path```. Caso não queira salvar o arquivo, basta ignorar o parâmetro, como no exemplo a seguir:

```{r example2}
library(eleicoesmun2020)

download_uf(estado = "RR", cargo = "prefeito")
```

Para baixar informações de _todos_ os estados, basta usar o parâmetro ```estado = "todos"```.

## Principais variáveis

```{r variaveis, echo = FALSE}
tibble::tribble(
              ~coluna,                                     ~descricao,
         "cand_sqcand",                       "id único do candidato",
              "cand_n",                 "número do candidato na urna",
             "cand_nm",                           "nome do candidato",
              "cand_e",                         "eleito (sim ou não)",
             "raiz_tf",              "totalização final (sim ou não)",
             "raiz_tv",                              "total de votos",
            "cand_vap", "quantidade de votos computados ao candidato",
  ) %>%
  knitr::kable()

```

Para entender as informações de cada coluna, verifique a [documentação do TSE](https://www.tse.jus.br/eleicoes/eleicoes-2020/arquivos/ea04-arquivo-de-resultado-consolidado-01-2020/rybena_pdf?file=https://www.tse.jus.br/eleicoes/eleicoes-2020/arquivos/ea04-arquivo-de-resultado-consolidado-01-2020/at_download/file).