pvsR (version 0.1.1)

Election.getStageCandidates: Get district basic election data according to election ID and stage ID

Description

This function is a wrapper for the Election.getStageCandidates() method of the PVS API Election class which grabs district basic election data according to the election and stage ID. The function sends a request with this method to the PVS API for all election and stage 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

Election.getStageCandidates(stageId, electionId)

Arguments

electionId

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

stageId

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

Value

• A data frame with a row for each combination of stage ID and election and columns with variables describing the election. The returned data frame contains a row for each combination of stage ID and election and columns with the following variables describing the election: stagecandidates.election*.electionId, stagecandidates.election*.name, stagecandidates.election*.stage, stagecandidates.election*.stateId, stagecandidates.candidate*.candidateId, stagecandidates.candidate*.officeId, stagecandidates.candidate*.district, stagecandidates.candidate*.firstName, stagecandidates.candidate*.middleName, stagecandidates.candidate*.lastName, stagecandidates.candidate*.suffix, stagecandidates.candidate*.party, stagecandidates.candidate*.status, stagecandidates.candidate*.voteCount, stagecandidates.candidate*.votePercent.

References

http://api.votesmart.org/docs/Election.html Use Election.getElectionByYearState() or Election.getElectionByZip() to get election 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 election data for certain election IDs
election <- Election.getStageCandidates(stageId=list("P"),electionId=list(2582,2607))
election