fetch_lords_parliamentary_roles: Fetch parliamentary roles for all Lords

In houseofcommonslibrary/clmnis: An R package for downloading data from the Parliamentary Members Names Information Service

Fetch parliamentary roles for all Lords

Description

fetch_lords_parliamentary_roles fetches data from the Members Names platform showing parliamentary roles for each Lord.

Usage

fetch_lords_parliamentary_roles(
  from_date = NA,
  to_date = NA,
  on_date = NA,
  while_lord = TRUE
)

Arguments

from_date	A string or Date representing a date. If a string is used it should specify the date in ISO 8601 date format e.g. '2000-12-31'. The default value is NA, which means no records are excluded on the basis of the from_date.
to_date	A string or Date representing a date. If a string is used it should specify the date in ISO 8601 date format e.g. 2000-12-31'. The default value is NA, which means no records are excluded on the basis of the to_date.
on_date	A string or Date representing a date. If a string is used it should specify the date in ISO 8601 date format e.g. 2000-12-31'. The default value is NA, which means no records are excluded on the basis of the on_date.
while_lord	A boolean indicating whether to filter the parliamentary roles to include only those roles that were held while each individual was serving as a Lord. The default value is TRUE.

Details

The from_date and to_date arguments can be used to filter the roles returned. The on_date argument is a convenience that sets the from_date and to_date to the same given date. The on_date has priority: if the on_date is set, the from_date and to_date are ignored.

The while_lord argument can be used to filter the roles to include only those that occurred during the period when each individual was a Lord.

The filtering is inclusive: a role is returned if any part of it falls within the period specified with the from and to dates.

Note that a role with an NA end date is still open.

Value

A tibble of parliamentary roles for each Lord, with one row per parliamentary role.

houseofcommonslibrary/clmnis documentation built on Aug. 17, 2024, 9:31 p.m.