pvsR (version 0.1.1)

Officials.getByOfficeState: Get a list of officials according to office

Description

This function is a wrapper for the Officials.getByOfficeState() method of the PVS API Officials class which grabs a list of officials according to office. The function sends a request with this method to the PVS API for all office 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.getByOfficeState(stateId="NA", officeId)

Arguments

officeId

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

stateId

a character string or list of character strings with the state ID(s) (default is "NA", for national) (see references for details)

Value

• A data frame with a row for each official and columns with variables describing the official. The returned data frame contains 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*.officeParties, candidatelist.candidate*.officeStatus, candidateList.candidate*.officeDistrictId, candidateList.candidate*.officeDistrictName, candidateList.candidate*.officeTypeId, candidateList.candidate*.officeId, candidateList.candidate*.officeName, candidateList.candidate*.officeStateId.

References

http://api.votesmart.org/docs/Officials.html Use State.getStateIDs() to get a list of state IDs. See http://api.votesmart.org/docs/semi-static.html or use Office.getOfficesByType(), Office.getOfficesByLevel(), Office.getOfficesByTypeLevel() or Office.getOfficesByBranchLevel() to get a list of office ID(s).

Examples

# First, make sure your personal PVS API key is saved as character string in the pvs.key variable:
pvs.key <- "yourkey"
# get a list of officials by state and office ID
officials <- Officials.getByOfficeState(,as.list(60:69))
officials