candidate_add_infor: Downloads data on the candidates - Addtional information

In electionsBR: R Functions to Download and Clean Brazilian Electoral Data

Downloads data on the candidates - Addtional information

Description

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

Usage

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

Arguments

year	Election year (integer). For this function, only the years 2024 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 recovers 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_add_infor returns a tbl, data.frame with the following variables:

Note

For the elections prior to 2024.

Examples

## Not run: 
df <- candidate_add_infor(2024)

## End(Not run)

electionsBR documentation built on April 4, 2025, 3:49 a.m.