fetch_commons_divisions_all: Fetch key details on all Commons divisions

Description Usage Arguments Details Value

View source: R/divisions_commons.R

Description

fetch_commons_divisions_all fetches a dataframe from the Commons Votes API showing key details about each division, with one row per division.

Usage

1
fetch_commons_divisions_all(from_date = NULL, to_date = NULL, on_date = NULL)

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 NULL, 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 NULL, 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 NULL, 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 divisions based on the dates they occurred. 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.

Value

A tibble of key details for each Commons division, with one row per division.


houseofcommonslibrary/clvotes documentation built on March 31, 2021, 2:38 a.m.