votesmart: Wrapper for the Project 'VoteSmart' API

Description

An R interface to the Project 'VoteSmart'https://justfacts.votesmart.org/ API.

Author(s)

Maintainer: Amanda Dobbyn amanda@deck.tools

Authors:

• Max Wood max@deck.tools

• Alyssa Frazee alyssa@deck.tools

Other contributors:

• Deck Technologies info@deck.tools [copyright holder, funder]

See Also

Useful links:

• https://github.com/decktools/votesmart/

• Report bugs at https://github.com/decktools/votesmart/issues/

Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Value

The left hand side object with the right hand side applied to it. Does not reassign this value to the left hand side.

Assignment pipe operator

Description

See magrittr::%<>% for details.

Usage

lhs %<>% rhs

Value

The left hand side object with the right hand side applied to it. Does reassign this value to the left hand side.

Get candidate data by last name

Description

Get candidate data by last name

Usage

candidates_get_by_lastname(
  last_names,
  election_years = lubridate::year(lubridate::today()),
  stage_ids = "",
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe of candidates and their attributes. If a given last_name + election_year + stage_id combination returns no data, that row will be filled with NAs.

Examples

## Not run: 
candidates_get_by_lastname(c("Ocasio-Cortez", "Omar"), 2018)

## End(Not run)

Get candidate data by Levenshtein distance from last name

Description

From the API docs, http://api.votesmart.org/docs/Candidates.html, "This method grabs a list of candidates according to a fuzzy lastname match."

Usage

candidates_get_by_levenshtein(
  last_names,
  election_years = lubridate::year(lubridate::today()),
  stage_ids = "",
  all = TRUE,
  verbose = TRUE
)

Arguments

Details

The actual Levenshtein distance of the result from the last_name provided is not available from the API.

Value

A dataframe of candidates and their attributes. If a given last_name + election_year + stage_id combination returns no data, that row will be filled with NAs.

Examples

## Not run: 
candidates_get_by_levenshtein(c("Bookr", "Klobucar"), 2020)

## End(Not run)

Get candidates by the state in which they hold office

Description

Get candidates by the state in which they hold office

Usage

candidates_get_by_office_state(
  state_ids = NA,
  office_ids,
  election_years = lubridate::year(lubridate::today()),
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe of candidates and their attributes. If a given state_id + office_id + election_year combination returns no data, that row will be filled with NAs.

Examples

## Not run: 
candidates_get_by_office_state(
  state_ids = c(NA, "NY", "CA"),
  office_ids = c("1", "6"),
  verbose = TRUE
)

## End(Not run)

Get election info by election year and state

Description

Get election info by election year and state

Usage

election_get_election_by_year_state(
  years = lubridate::year(lubridate::today()),
  state_ids = "",
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe of candidates and their attributes. If a given year + state_id returns no data, that row will be filled with NAs.

Examples

## Not run: 
election_get_election_by_year_state(years = c(2016, 2017))

## End(Not run)

Endpoint-Input Mapping

Description

Unnested tibble containing the mapping between each endpoint, the inputs it takes, and whether those inputs are required. One or more input rows per endpoint.

Usage

endpoint_input_mapping

Format

A tibble with 108 rows and 3 variables:

endpoint

name of the API endpoint

input

one or multiple inputs that can be used in the request to that endpoint

required

boolean: whether that input is required for that endpoint

Source

http://api.votesmart.org/docs/

Nested Endpoint-Input Mapping

Description

Nested tibble containing the mapping between each endpoint, the inputs it takes, and whether those inputs are required.

Usage

endpoint_input_mapping_nested

Format

A tibble with 70 rows and 2 variables:

endpoint

name of the API endpoint

inputs

a list column containing one or more inputs and a boolean indicating whether they are required for that endpoint. Can be unnested with tidyr::unnest

Source

http://api.votesmart.org/docs/

Get information on a ballot measure

Description

Ballot measure ids can be found with the measure_get_measures_by_year_state function.

Usage

measure_get_measures(measure_ids, verbose = TRUE)

Arguments

Value

A dataframe with the columns measure_id, measure_code, title, election_date, election_type, outcome, yes_votes, no_votes, summary, summary_url, measure_text, text_url, pro_url, con_url.

Examples

## Not run: 
measure_get_measures("1234")

## End(Not run)

Get a dataframe of ballot measures by year and state

Description

More information about these ballot measures can be found using the measure_get_measures function.

Usage

measure_get_measures_by_year_state(
  years = lubridate::year(lubridate::today()),
  state_ids = state.abb,
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe of ballot measures and their attributes. If a given year + state_id returns no data, that row will be filled with NAs.

Examples

## Not run: 
measure_get_measures_by_year_state(years = c(2016, 2018), state_ids = c("MO", "IL", "VT"))

## End(Not run)

Get office levels

Description

These are currently: F for Federal, S for State, and L for Local.

Usage

office_get_levels()

Value

A dataframe with the columns office_level_id and name.

Examples

## Not run: 
office_get_levels()

## End(Not run)

Get offices by level

Description

Get offices by level

Usage

office_get_offices_by_level(office_level_ids)

Arguments

Value

A dataframe with columns office_id, name, title, office_level_id, office_type_id, office_branch_id, short_title.

Examples

## Not run: 
office_get_offices_by_level("F")

office_get_levels() %>%
  pull(office_level_id) %>%
  .[1] %>%
  office_get_offices_by_level()

## End(Not run)

Get SIG (Special Interest Group) ratings for candidates

Description

Get SIG (Special Interest Group) ratings for candidates

Usage

rating_get_candidate_ratings(
  candidate_ids,
  sig_ids = "",
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe with the columns rating_id, candidate_id, sig_id, rating, rating_name, timespan, categories, rating_text.

Examples

## Not run: 
pelosi_id <- "26732"
rating_get_candidate_ratings(pelosi_id)

## End(Not run)

Get categories that contain ratings by state

Description

Get categories that contain ratings by state

Usage

rating_get_categories(state_ids = NA)

Arguments

Value

A dataframe with columns category_id, name, state_id.

Examples

## Not run: 
rating_get_categories("NM")

## End(Not run)

Get information on a SIG (Special Interest Group) by its ID

Description

Get information on a SIG (Special Interest Group) by its ID

Usage

rating_get_sig(sig_ids, verbose = TRUE)

Arguments

Value

A dataframe with the columns sig_id, name, description, state_id, address, city, state, zip, phone_1, phone_2, fax, email, url, contact_name.

Examples

## Not run: 
rating_get_sig_list(2) %>%
  dplyr::pull(sig_id) %>%
  sample(3) %>%
  rating_get_sig()

## End(Not run)

Get SIG (Special Interest Group) list by category and state

Description

Get SIG (Special Interest Group) list by category and state

Usage

rating_get_sig_list(category_ids, state_ids = NA, all = TRUE, verbose = TRUE)

Arguments

Value

A dataframe with the columns sig_id, name, category_id, state_id.

Examples

## Not run: 
rating_get_categories() %>%
  dplyr::pull(category_id) %>%
  sample(3) %>%
  rating_get_sig_list()

## End(Not run)

Get votes by official

Description

Get votes by official

Usage

votes_get_by_official(
  candidate_ids,
  office_ids = "",
  category_ids = "",
  years = "",
  all = TRUE,
  verbose = TRUE
)

Arguments

Value

A dataframe of candidates' votes on bills and their attributes. If a given input combination returns no data, that row will be filled with NAs.

Examples

## Not run: 
aoc <- candidates_get_by_lastname(
  "ocasio-cortez",
  election_years = "2018"
)
votes_get_by_official(aoc$candidate_id)

## End(Not run)