pvsR (version 0.1.1)

Office.getOfficesByType: Get offices tracked according to type

Description

This function is a wrapper for the Office.getOfficesByType() method of the PVS API Office class which grabs a list of offices Project Vote Smart keeps track of according to their type. The function sends a request with this method to the PVS API for all office type 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

Office.getOfficesByType(officeTypeId)

Arguments

officeTypeId

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

Value

• A data frame with a row for each office and columns with the following variables describing the office. The returned data frame contains a row for each office and columns with the following variables describing the office: offices.office*.officeId, offices.office*.officeTypeId, offices.office*.officeLevelId, offices.office*.officeBranchId, offices.office*.name, offices.office*.title, offices.office*.shortTitle.

References

http://api.votesmart.org/docs/Office.html See http://api.votesmart.org/docs/semi-static.html or use Office.getTypes() or Office.getOfficesByLevel() to get a list of office types 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 offices tracked for certain office types
offices <- Office.getOfficesByType(list("S","K","L"))
offices