electionsBR (version 0.4.0)

vote_mun_zone: Download data on candidate electoral results in federal elections in Brazil

Description

vote_mun_zone() downloads and aggregates data on the verification of federal elections in Brazil, disaggregated by cities and electoral zone. The function returns a data.frame where each observation corresponds to a city/zone.

Usage

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

Value

vote_mun_zone() returns a data.frame with the following variables:

Arguments

year

Election year. For this function, only the years 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 'Latin-1'). This can be changed to avoid errors when ascii = TRUE.

temp

(logical). If TRUE, keep the temporary compressed file for future use (recommended)

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.

Examples

if (FALSE) {
df <- vote_mun_zone(2002)
}