Office.getOfficesByType: Get offices tracked according to type

Description Usage Arguments Value Author(s) References Examples

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

1

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:
offices.office*.officeId,
offices.office*.officeTypeId,
offices.office*.officeLevelId,
offices.office*.officeBranchId,
offices.office*.name,
offices.office*.title,
offices.office*.shortTitle.

Author(s)

Ulrich Matter <ulrich.matter-at-unibas.ch>

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).
See also: Matter U, Stutzer A (2015) pvsR: An Open Source Interface to Big Data on the American Political Sphere. PLoS ONE 10(7): e0130501. doi: 10.1371/journal.pone.0130501

Examples

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 offices tracked for certain office types
## Not run: offices <- Office.getOfficesByType(list("S","K","L"))
## Not run: head(offices)

umatter/pvsR documentation built on Jan. 9, 2021, 4:35 p.m.