Election.getElectionByYearState: Get district basic election data according to year and state...

Description Usage Arguments Value Author(s) References Examples

Description

This function is a wrapper for the Election.getElectionByYearState() method of the PVS API Election class which grabs district basic election data. The function sends a request with this method to the PVS API for all state IDs and years given as a function input, extracts the XML values from the returned XML file(s) and returns them arranged in one data frame.

Usage

1
Election.getElectionByYearState(stateId="NA", year)

Arguments

stateId

(optional) a character string or list of character strings with the state ID(s) (default: "NA", for national) (see references for details)

year

a character string or list of character strings with the years (defaults to current year)

Value

A data frame with a row for each election and columns with the following variables describing the election:
elections.election*.electionId,
elections.election*.name,
elections.election*.stateId,
elections.election*.officeTypeId,
elections.election*.special,
elections.election*.electionYear.
For each stage the following variables are jointly (as one string) in a column:
elections.election*.stage*.stageId,
elections.election*.stage*.name,
elections.election*.stage*.stateId,
elections.election*.stage*.electionDate,
elections.election*.stage*.filingDeadline,
elections.election*.stage*.npatMailed.

Author(s)

Ulrich Matter <ulrich.matter-at-unibas.ch>

References

http://api.votesmart.org/docs/Election.html
Use State.getStateIDs() to get a list of state IDs.
See also: Matter U, Stutzer A (2015) pvsR: An Open Source Interface to Big Data on the American Political Sphere. PLoS ONE 10(7): e0130501. doi: 10.1371/journal.pone.0130501

Examples

1
2
3
4
5
6
# First, make sure your personal PVS API key is saved as an option
# (options("pvs.key" = "yourkey")) or in the pvs.key variable:
## Not run: pvs.key <- "yourkey"
# get information about an election of a certain year and state 
## Not run: election <- Election.getElectionByYearState(list("NY","FL"),2012)
## Not run: election

umatter/pvsR documentation built on Jan. 9, 2021, 4:35 p.m.