getAllDistricts: Get basic data on all districts

In umatter/pvsR: Interact with the Project Vote Smart API for Scientific Research

Description

This function is essentially a wrapper around District.getByOfficeState().

Usage

getAllDistricts()

Value

A data frame with a row for each district and columns with the following variables describing the district:
districtList.district*.districtId,
districtList.district*.name,
districtList.district*.officeId,
districtList.district*.stateId.

Author(s)

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

References

http://api.votesmart.org/docs/District.html
See http://api.votesmart.org/docs/semi-static.html for a list of office IDs or use Office.getOfficesByType(), Office.getOfficesByLevel(), Office.getOfficesByTypeLevel() or Office.getOfficesByBranchLevel().
Use State.getStateIDs() to get a list of state 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

# 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 all districts
## Not run: districts <- getAllDistricts()
## Not run: head(districts)

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