commons_terms: Parliamentary Thesaurus

Description Usage Arguments Value Examples

View source: R/commons_terms.R

Description

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

Usage

1
2
3
4
5
commons_terms(search = NULL, class = NULL, extra_args = NULL,
  tidy = TRUE, tidy_style = "snake_case", verbose = FALSE)

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

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. See the API documentation or the package vignette for more details. Defaults to NULL.

tidy

Logical parameter. If TRUE, fixes 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'.

verbose

If TRUE, returns data to console on the progress of the API request. Defaults to FALSE.

Value

A tibble with results from the parliamentary thesaurus.

Examples

1
2
3
4
5
6
## Not run: 
x <- commons_terms(search='estate')

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

## End(Not run)

hansard documentation built on Oct. 10, 2017, 1:08 a.m.