Leadership.getOfficials: Get officials that hold the leadership role in certain states

Description Usage Arguments Value Author(s) References Examples

Description

This function is a wrapper for the Leadership.getOfficials() method of the PVS API Leadership class which grabs a list of officials that hold the leadership role in certain states. The function sends a request with this method to the PVS API for all state and leadership 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
Leadership.getOfficials(stateId="NA", leadershipId)

Arguments

stateId

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

leadershipId

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

Value

A data frame with a row for each leadership position and columns with the following variables describing the official:
leaders.leader*.candidateId,
leaders.leader*.firstName,
leaders.leader*.middleName,
leaders.leader*.lastName,
leaders.leader*.suffix,
leaders.leader*.position,
leaders.leader*.officeId,
leaders.leader*.title.

Author(s)

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

References

http://api.votesmart.org/docs/Leadership.html
Use State.getStateIDs() to get a list of state IDs.
Use Leadership.getPositions() to get a list of leadership IDs.
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 leaders by state ID and leadership ID 
## Not run: officials <- Leadership.getOfficials(list("NY","FL"),list(138,140))
## Not run: officials

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