pvsR (version 0.1.1)

Office.getOfficesByBranchLevel: Get offices tracked according to branch and level

Description

This function is a wrapper for the Office.getOfficesByBranchLevel() method of the PVS API Office class which grabs a list of offices Project Vote Smart keeps track of according to government branch and level. The function sends a request with this method to the PVS API for all branch and level 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.getOfficesByBranchLevel(branchId, levelId)

Arguments

branchId

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

levelId

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

Value

• A data frame with a row for each office and columns with 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 Use Office.getBranches() to get branch ID(s). Use Office.getLevels() to get level 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 all branch and level IDs
offices <- Office.getOfficesByBranchLevel(list("E","L","J"),list("F","S","L"))
offices