mnis (version 0.3.1)

mnis_general_election_results: Election results

Description

Returns an object containing list with details of the search parameter and a tibble with election results. Accepts queries on location type and name, and the start and end date to return general elections between. The API does not contain data for Norther Ireland.

Usage

mnis_general_election_results(
  location_type = "Country",
  location_name = "Great Britain",
  start_date = "1900-01-01",
  end_date = Sys.Date(),
  tidy = TRUE,
  tidy_style = "snake_case"
)

Arguments

location_type

The type of area to return information for. Accepts 'Country', 'Region', 'County', and 'Constituency'. Defaults to 'Country'.

location_name

The location to return data for. It can be the name of any Country, Region, County or Constituency. Defaults to 'Great Britain'.

start_date

Start date of search. Accepts character values in 'YYYY-MM-DD' format, and objects of class Date, POSIXt, POSIXct, POSIXlt or anything else than can be coerced to a date with as.Date(). Defaults to '1900-01-01'.

end_date

End date of search. Accepts character values in 'YYYY-MM-DD' format, and objects of class Date, POSIXt, POSIXct, POSIXlt or anything else than can be coerced to a date with as.Date(). Defaults to current system date.

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

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

Examples

# NOT RUN {
x <- mnis_general_election_results(
  location_type = "Country", location_name = "England",
  start_date = "2010-01-01", end_date = "2016-01-01"
)
# }
# NOT RUN {
# }