Description Usage Arguments Value Author(s) References Examples
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.
1 | Officials.getByOfficeState(stateId="NA", officeId)
|
stateId |
a character string or list of character strings with the state ID(s) (default is "NA", for national) (see references for details) |
officeId |
a character string or list of character strings with the office ID(s) (see references for details) |
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*.officeParties,
candidatelist.candidate*.officeStatus,
candidateList.candidate*.officeDistrictId,
candidateList.candidate*.officeDistrictName,
candidateList.candidate*.officeTypeId,
candidateList.candidate*.officeId,
candidateList.candidate*.officeName,
candidateList.candidate*.officeStateId.
Ulrich Matter <ulrich.matter-at-unibas.ch>
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).
1 2 3 4 5 6 | # 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 a list of officials by state and office ID
## Not run: officials <- Officials.getByOfficeState(,as.list(60:69))
## Not run: officials
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.