mnis_constituency_results: Constituency election results

Description Usage Arguments Value Examples

View source: R/mnis_constituency_results.R

Description

Returns a list with details of the constituency and a tibble with election results.

Usage

1
2
3
4
5
6
mnis_constituency_results(
  constituency_id = NULL,
  election_id = 0,
  tidy = TRUE,
  tidy_style = "snake_case"
)

Arguments

constituency_id

The ID of the constituency to return the data for. If NULL, no data is returned. Defaults to NULL.

election_id

The ID of the election to return the data for. Defaults to 0, which returns the result of all elections held in that constituency.

tidy

If TRUE, fixes the variable names in the tibble to remove non-alphanumeric characters and superfluous text, and convert to a consistent style. Defaults to TRUE.

tidy_style

The style to convert variable names to, if tidy=TRUE. Accepts one of "snake_case", "camelCase" and "period.case". Defaults to "snake_case".

Value

A list with details of the constituency, labelled 'details' and a tibble with election results, labelled 'results'. The list and tibble are stored in a single object.

Examples

1
2
3
4
## Not run: 
x <- mnis_constituency_results(constituency_id = 3709, election_id = 0)

## End(Not run)

EvanOdell/mnis documentation built on April 5, 2021, 7:37 a.m.