candidate_fed: Download data on the candidates' backgrounds in federal elections

Description

candidate_fed() 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_fed(
  year,
  uf = "all",
  br_archive = FALSE,
  ascii = FALSE,
  encoding = "latin1",
  export = FALSE,
  temp = TRUE
)

Value

candidate_fed() returns a tbl, data.frame with the following variables:

DATA_GERACAO: Generation date of the file (when the data was collected).
HORA_GERACAO: Generation time of the file (when the data was collected), Brasilia Time.
ANO_ELEICAO: Election year.
NUM_TURNO: Round number.
DESCRICAO_ELEICAO: Description of the election.
SIGLA_UF: Units of the Federation's acronym in which occurred the election.
SIGLA_UE: Units of the Federation's acronym (In case of major election is the FU's acronym in which the candidate runs for (text) and in case of municipal election is the municipal's Supreme Electoral Court code (number)). Assume the special values BR, ZZ and VT to designate, respectively, Brazil, Overseas and Absentee Ballot.
DESCRICAO_UE: Description of the Electoral Unit.
CODIGO_CARGO: Code of the position that the candidate runs for.
DESCRICAO_CARGO: Description of the position that the candidate runs for.
NOME_CANDIDATO: Candidate's complete name.
SEQUENCIAL_CANDIDATO: Candidate's sequence number generated internally by the electoral systems. It is not the candidate's campaign number.
NUMERO_CANDIDATO: Candidate's number in the ballot box.
CPF_CANDIDATO: Candidate's CPF.
NOME_URNA_CANDIDATO: Candidate's ballot box name.
COD_SITUACAO_CANDIDATURA: Code of the candidature situation.
DES_SITUACAO_CANDIDATURA: Description of the candidature situation.
NUMERO_PARTIDO: Party number.
SIGLA_PARTIDO: Party acronym.
NOME_PARTIDO: Party name.
CODIGO_LEGENDA: Sequential code of the party shortname generated by the Electoral Justice.
SIGLA_LEGENDA: Party's shortname acronym.
COMPOSICAO_LEGENDA: Party's shortname composition.
NOME_COLIGACAO: Coalition shortname.
CODIGO_OCUPACAO: Candidate's occupation code.
DESCRICAO_OCUPACAO: Candidate's occupation description.
DATA_NASCIMENTO: Candidate's date of birth.
NUM_TITULO_ELEITORAL_CANDIDATO: Candidate's ballot number.
IDADE_DATA_ELEICAO: Candidate's age on the day of election.
CODIGO_SEXO: Candidate's sex code.
DESCRICAO_SEXO: Candidate's sex description.
COD_GRAU_INSTRUCAO: Candidate's level of education code. Generated internally by the electoral systems.
DESCRICAO_GRAU_INSTRUCAO: Candidate's level of education description.
CODIGO_ESTADO_CIVIL: Candidate's marital status code.
DESCRICAO_ESTADO_CIVIL: Candidate's marital status description.
CODIGO_NACIONALIDADE: Candidate's nationality code.
DESCRICAO_NACIONALIDADE: Candidate's nationality description.
SIGLA_UF_NASCIMENTO: Candidate's Units of the Federation birth's acronym.
COD_MUNICIPIO_NASCIMENTO: Candidate's birth city's Supreme Electoral Court code.
COD_MUNICIPIO_NASCIMENTO: Candidate's birth city.
DESPESA_MAX_CAMPANHA: Maximum expenditure campaign declared by the party to that position. Values in Reais.
COD_SIT_TOT_TURNO: Candidate's totalization status code in that election round.
DESC_SIT_TOT_TURNO: Candidate's totalization status description in that round.
CODIGO_COR_RACA: Candidate's color/race code (self-declaration, only from 2014 election).
DESCRICAO_COR_RACA: Candidate's color/race description (self-declaration, only from 2014 election).
EMAIL_CANDIDATO: Candidate's e-mail adress (only from 2014 election).

From 2018 on, some new variables are also available:

COD_TIPO_ELEICAO: Election type code.
NOME_TIPO_ELEICAO: Election type.
COD_ELEICAO: Election code.
DATA_ELEICAO: Election date.
ABRANGENCIA: Election scope.
NOME_SOCIAL_CANDIDATO: Candidate's social name.
EMAIL_CANDIDATO: Candidate's e-mail.
COD_DETALHE_SITUACAO_CAND: Details on the status of a candidate's elegibility.
DES_DETALHE_SITUACAO_CAND: Description of a candidate's elegibility.
TIPO_AGREMIACAO: Type of partisan ticket (electoral coalition or single party).
IDADE_DATA_POSSE: Candidate's age at the first day in the office.
CODIGO_COR_RACA: Candidates' skin color code.
DESCRICAO_COR_RACA: Candidates' skin color.
SITUACAO_REELEICAO: Candidate's reelection status (running for reelection or not).
SITUACAO_DECLARAR_BENS: Candidate's financial disclosure.
NUMERO_PROTOCOLO_CANDIDATURA: Candidate's electoral protocol number.
NUMERO_PROCESSO: Candidate's electoral process.

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).
ascii: (logical). Should the text be transformed from latin1 to ASCII format?
encoding: Data original encoding (defaults to 'latin1'). This can be changed to avoid errors when ascii = TRUE.
export: (logical). Should the downloaded data be saved in .dta and .sav in the current directory?
temp: (logical). elections_rda

Details

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

Examples

Run this code

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