mnis (version 0.3.1)

mnis_eligible: mnis_eligible

Description

Returns all members who are able to sit in either house, or who are currently ineligible to sit. Members ineligible to sit include but are not necessarily limited to former MPs, members of the judiciary, who are recused from House of Lords duties.

Usage

mnis_eligible(
  eligible = TRUE,
  house = "all",
  party = NULL,
  tidy = TRUE,
  tidy_style = "snake_case"
)

Arguments

eligible

If the member is currently eligible to sit. Accepts TRUE or FALSE. Defaults to TRUE.

house

The house to which the member belongs. Accepts one of 'all', 'lords' and 'commons', defaults to 'all'. This parameter is not case sensitive, so 'commons', 'Commons' and 'cOmMOnS' will all return the same data.

party

The party to which a member belongs. Defaults to NULL. The party must be fully spelled out (e.g. 'green party'), the API does not accept searches on this parameter. For a tibble of parties, see ref_parties(). This parameter is not case sensititive.

tidy

Fix the variable names in the tibble to remove special characters and superfluous text, and converts the variable names 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"

Examples

# NOT RUN {
x <- mnis_eligible(eligible = FALSE, house = "all", party = "labour")

y <- mnis_eligible(eligible = TRUE, house = "all", party = "green party")

z <- mnis_eligible(house = "commons")
# }
# NOT RUN {
# }