Officials.getByDistrict: Get a list of officials according to the district they are...

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.getByDistrict() method of the PVS API Officials class which grabs a list of officials according to the district they are running for. The function sends a request with this method to the PVS API for all district IDs 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.getByDistrict(districtId)

Arguments

districtId

a character string or list of character strings with the district ID(s) (see references for details)

Value

A data frame with a row for each official and columns with the following variables describing the official:
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
Use District.getByOfficeState() or District.getByZip() to get a list of district ID(s).

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 officials by dristrict ID
## Not run: officials <- Officials.getByDistrict(as.list(25157:25163))
## Not run: officials

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