candidate: Download data on the candidates' backgrounds in federal...

View source: R/candidate.R

candidateR Documentation

Download data on the candidates' backgrounds in federal elections

Description

candidate() downloads and aggregates data on the candidates' background who ran in federal elections in Brazil. The function returns a data.frame where each observation corresponds to a candidate.

Usage

candidate(
  year,
  uf = "all",
  br_archive = FALSE,
  encoding = "latin1",
  temp = TRUE,
  readme_pdf = FALSE
)

Arguments

year

Election year (integer). For this function, only the years 1994, 1998, 2002, 2006, 2010, 2014, and 2018 are available.

uf

Federation Unit acronym (character vector).

br_archive

In the TSE's data repository, some results can be obtained for the whole country by loading a single within a single file by setting this argument to TRUE (may not work in for some elections and, in other, it recoverns only electoral data for presidential elections, absent in other files).

encoding

Data original encoding (defaults to 'latin1'). This can be changed to avoid errors when ascii = TRUE.

temp

(logical). temp

readme_pdf

original readme

Details

If export is set to TRUE, the downloaded data is saved as .dta and .sav files in the current directory.

Value

candidate returns a tbl, data.frame with the following variables:

Note

For the elections prior to 2002, some information can be incomplete. For the 2014 and 2018 elections, more variables are available.

Examples

## Not run: 
df <- candidate(2002)

## End(Not run)

electionsBR documentation built on May 29, 2024, 7:16 a.m.