appg_benefits: Fetch details on APPG benefits in kind

In dempseynoel/parlygroups: A package for scraping data from the "Register of All-Party Parliamentary Groups".

Fetch details on APPG benefits in kind

Description

appg_benefits retrieves details on benefits in kind given to APPGs along with the source of the benefit, benefit value range, date recieved and registered. Each row is one APPG benefit in kind record.

Usage

appg_benefits(appg = NA, category = NA, source = NA,
  low_value_from = NA, low_value_to = NA, high_value_from = NA,
  high_value_to = NA, received_from = NA, received_to = NA,
  registered_from = NA, registered_to = NA)

Arguments

appg	A character string of an APPG title written within a pair of single qoute or double qoutes. Can be a vector with more than one element. By default all APPG titles are selected.
category	A characer string of a APPG type written within a pair of single qoute or double qoutes. APPG types available: Country, Subject, Club. Can be a vector with more than one element. By default all APPG types are selected.
source	A character string of the source of benefit in kind written within a pair of single qoute or double qoutes. Can be a vector with more than one element. By default all sources are selected.
low_value_from	A non-negative numeric indicating the lower value range of the benefit in kind. By default the minimum value in the data is used.
low_value_to	A non-negative numeric indicating the lower value range of the benefit in kind. By default the maximum value if the data is used.
high_value_from	A non-negative numeric indicating the higher value range of the benefit in kind. By default the minimum value in the data is used.
high_value_to	A non-negative numeric indicating the higher value range of the benefit in kind. By default the maximum value if the data is used.
received_from	A character string of the date when the benefit in kind was received written within a pair of single qoute or double qoutes. The date must be in ISO 8601 format, i.e. ("YYYY-MM-DD"). By default the earliest date in the data is used.
received_to	A character string of the date when the benefit in kind was received written within a pair of single qoute or double qoutes. The date must be in ISO 8601 format, i.e. ("YYYY-MM-DD"). By default the latest date in the data is used.
registered_from	A character string of the date when the benefit in kind was registered written within a pair of single qoute or double qoutes. The date must be in ISO 8601 format, i.e. ("YYYY-MM-DD"). By default the earliest date in the data is used.
registered_to	A character string of the date when the benefit in kind was registered written within a pair of single qoute or double qoutes. The date must be in ISO 8601 format, i.e. ("YYYY-MM-DD"). By default the latest date in the data is used.

Details

If no parameters are supplied the function will return a tibble of all benefits in kind to APPGs.

Value

A tibble of key details on APPG benefits in kind, with one row per APPG benefit in kind.

Examples

appg_benefits()
appg_benefits(category = "Subject", low_value_from = 1000, low_value_to = 2000)
appg_benefits(received_from = "2018-01-01", received_to = "2018-06-01")

dempseynoel/parlygroups documentation built on Sept. 30, 2024, 11:31 p.m.