Election.getElectionByZip: Get district basic election data according to the ZIP code

Description Usage Arguments Value Author(s) References Examples

Description

This function is a wrapper for the Election.getElectionByZip() method of the PVS API Election class which grabs district basic election data according to the ZIP code. If another year than the current year is chosen, all election data from that year up to the current year is returned. The function sends a request with this method to the PVS API for all ZIP codes 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

Arguments

zip5

a character string or list of character strings with the five-digit ZIP code

zip4

(optional) a character string or list of character strings with the expanded ZIP+4 code (default: NULL)

year

a character string or list of character strings with the year (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.

Author(s)

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

References

http://api.votesmart.org/docs/Election.html
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
# First, make sure your personal PVS API key is saved as character string in the pvs.key variable:
## Not run: pvs.key <- "yourkey"
# get election data by ZIP code 
## Not run: election <- Election.getElectionByZip(zip5=list(10001,10002), year="2012")
## Not run: election

umatter/pvsR documentation built on May 31, 2019, 1:55 a.m.