Officials.getByZip: Get a list of officials according to the ZIP code

In pvsR: An R package to interact with the Project Vote Smart API for scientific research

Description

This function is a wrapper for the Officials.getByZip() method of the PVS API Officials class which grabs a list of officials according to the ZIP code of the area they represent. 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

Officials.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 official and columns with the following variables describing the official:
candidateList.zipMessage,
candidateList.candidate*.candidateId,
candidateList.candidate*.firstName,
candidateList.candidate*.nickName,
candidateList.candidate*.middleName,
candidateList.candidate*.lastName,
candidateList.candidate*.suffix,
candidateList.candidate*.title,
candidateList.candidate*.electionParties,
candidateList.candidate*.electionstatus,
candidateList.candidate*.officeParties,
candidatelist.candidate*.officeStatus,
candidateList.candidate*.officeDistrictId,
candidateList.candidate*.officeDistrictName,
candidateList.candidate*.officeTypeId,
candidateList.candidate*.officeId,
candidateList.candidate*.officeName,
candidateList.candidate*.officeStateId.

Author(s)

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

References

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

Examples

# First, make sure your personal PVS API key is saved as character string in the pvs.key variable:
## Not run: pvs.key <- "yourkey"
# get a list of officials by ZIP code
## Not run: officials <- Officials.getByZip(list(10001,10002))
## Not run: head(officials)

pvsR documentation built on May 2, 2019, 5:16 a.m.