hansard (version 0.5.0)

commons_terms: Imports the parliamentary thesaurus. The API is rate limited to 5500 requests at a time, so some use of parameters is required.

Description

Imports the parliamentary thesaurus. The API is rate limited to 5500 requests at a time, so some use of parameters is required.

Usage

commons_terms(search = NULL, class = NULL, extra_args = NULL,
  tidy = TRUE, tidy_style = "snake_case")
hansard_commons_terms(search = NULL, class = NULL, extra_args = NULL,
  tidy = TRUE, tidy_style = "snake_case")

Arguments

search

A string to search the parliamentary thesaurus for.

class

The class of definition to be returned Accepts one of 'ID', 'ORG', 'SIT', 'NAME', 'LEG','CTP', 'PBT' and 'TPG'. Defaults to NULL

extra_args

Additional parameters to pass to API. Defaults to NULL.

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'.

Value

A tibble with results from the parliamentary thesaurus.

Examples

# NOT RUN {
x <- commons_terms(search='estate')

x <- commons_terms(search='estate', class='ORG')

# }