pvsR (version 0.1.1)

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

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 variables describing the district. The returned data frame contains 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.

References

http://api.votesmart.org/docs/District.html

Examples

# First, make sure your personal PVS API key is saved as character string in the pvs.key variable:
pvs.key <- "yourkey"
# get district IDs by ZIP Code
district <- District.getByZip(list(10001,10002),)
district