District.getByZip: Get district IDs according to the zip code

In umatter/pvsR: Interact with the Project Vote Smart API for Scientific Research

Description

This function is a wrapper for the District.getByZip() method of the PVS API District class which grabs district IDs according to the ZIP code. 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

District.getByZip(zip5, zip4=NULL)

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: All)

Value

A data frame with a row for each district and columns with the following variables describing the district:
districtList.district*.districtId,
districtList.district*.name,
districtList.district*.officeId,
districtList.district*.stateId.

Author(s)

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

References

http://api.votesmart.org/docs/District.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

# 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 district IDs by ZIP Code
## Not run: district <- District.getByZip(list(10001,10002))
## Not run: district

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