fetch_lords_memberships: Fetch Lords memberships for all Lords

View source: R/lords.R

fetch_lords_membershipsR Documentation

Fetch Lords memberships for all Lords

Description

fetch_lords_memberships fetches data from the Members Names platform showing Lords memberships for each Lord. The memberships are processed to impose consistent rules on the start and end dates for memberships. A membership with an NA end date is still open.

Usage

fetch_lords_memberships(from_date = NA, to_date = NA, on_date = NA)

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.

Details

The from_date and to_date arguments can be used to filter the memberships 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 filtering is inclusive: a membership is returned if any part of it falls within the period specified with the from and to dates.

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

Value

A tibble of Lords memberships for each Lord, with one row per Lords membership.


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