mayor: Extract data of Brazilian mayoral polls.
In voltdatalab/pollingbr: Extract Data of Brazilian Electoral Pools

Description Usage Arguments Value Examples

View source: R/mayor.R

mayor() extracts data of Brazilian mayoral polls from the Poder 360's poll agreggator API (https://www.poder360.com.br/pesquisas-de-opiniao/api/). The function returns a data.frame where each observation corresponds to a candidate's estimate in a poll.

1	mayor(year, state = "ALL", round = c(1, 2), type = c(1, 2, 3))

`year`	Election year (`integer`). Available years are 2000, 2004, 2008, 2012 and 2016.
`state`	Initials in capital letters (`character`) of the state (if the poll was conducted only in state-level) or the country ("BR", if it was in national-level). Default returns all presidential polls for the corresponding election year.
`round`	Number (`integer`) corresponding to the election round that the poll corresponds. Default returns polls for both first and second rounds.
`type`	Number (`character`) indicating if the user wants the spontaneous (1), estimulated (2), or rejection (3) estimations of polls. Default returns all poll results.

data.frame with results from polls conducted for mayoral elections in Brazil, for the year specified, with the following variables:

pesquisa_id: id number for each poll.
ano: election year to which the poll corresponds to.
unidades_federativas_id: id number for the federative unit where the poll was conducted.
unidade_federativa_nome: the name of the federative unit where the poll was conducted (if the poll was conducted on national-level, this variable assumes the value of "BRASIL").
cargos_id: id number for the position polled.
cargo: name of the position polled.
tipo_id: id number for type of poll.
tipo: type of poll.
turno: indicates if election polled was a 1st round or 2nd round one.
data_pesquisa: poll date ("YYYY-MM-DD").
instituto_id: id number for the institute which conducted the poll.
instituto: name of the institute which conducted the poll.
voto_tipo: indicates if the estimate relates to total votes ("Votos Totais") or valid votes ("Votos Válidos").
cenario_id: id number for the candidates' scenario that was polled.
cenario_descricao: description of the candidates' scenario that was polled.
candidatos_id: candidate's id number.
candidato_partido: candidate's name and party affiliation.
candidato: candidate's name.
ano_default: indicates the year-position that the candidate ran.
condicao: indicate if it's a candidate (0) or a broad category (such as null and/or blank vote, would vote for all, etc.)
percentual: vote estimate for the candidate in the poll, in percentage points.
data_referencia: poll's reference date ("DD-DD.MM.YYYY")
margem_mais: estimate of the poll's margin of error upper limit.
margem_menos: estimate of the poll's margin of error lower limit.
contratante: indicates who hired the poll.
num_registro: poll's register number in the Brazilian Electoral Courts.
orgao_registro: Brazilian Electoral Court where the poll was registered.
qtd_entrevistas: number of interviews conducted in the poll (poll's sample size).
partidos_id: candidate's party id number.
partido: candidate's party abbreviated name.
cidade: city where the poll was conducted.

# returns a data.frame with the results for mayoral polls
# conducted in the 2016 elections
df <- mayor(2016)

# returns a data.frame with results for all polls in the
# secound round of the 2008 mayoral elections in all of
# Brazilian southeastern states.
df<- mayor(2008, state = c("ES", "MG", "RJ", "SP"), round = 2)