Votes.getBillsByOfficialYearOffice: Get a list of bills according to office (optional), candidate...

Description Usage Arguments Value Author(s) References Examples

Description

This function is a wrapper for the Votes.getBillsByOfficialYearOffice() method of the PVS API Votes class which grabs a list of bills that fit the candidate and year. The function sends a request with this method to the PVS API for all years, candidate and office 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
Votes.getBillsByOfficialYearOffice(year, candidateId, officeId=NULL)

Arguments

year

a character string or list of character strings with the year ID(s)

candidateId

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

officeId

(optional) a character string or list of character strings with the office ID(s) (default: all) (see references for details)

Value

A data frame with a row for each bill and columns with the following variables describing the bill:
bills.bill*.billId,
bills.bill*.billNumber,
bills.bill*.title,
bills.bill*.type.

Author(s)

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

References

http://api.votesmart.org/docs/Votes.html
Use Candidates.getByOfficeState(), Candidates.getByOfficeTypeState(), Candidates.getByLastname(), Candidates.getByLevenshtein(), Candidates.getByElection(), Candidates.getByDistrict() or Candidates.getByZip() to get a list of candidate IDs.
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
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 a list of bills for a certain office, candidate and year 
## Not run: bills <- Votes.getBillsByOfficialYearOffice(list(2010,2011,2012),107800,)
## Not run: bills

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