research_briefings: Parliamentary Research Briefings

Description Usage Arguments Value See Also Examples

View source: R/research_briefings.R

Description

Imports data on Parliamentary Research Briefings. To see a list of possible topics call research_topics_list or research_subtopics_list for both topics and subtopics. To see a list of briefing types, call research_types_list. This function can return results with newlines in the text of the abstract or description of the research briefing, represented as '\n'.

Usage

1
2
3
4
5
6
7
research_briefings(topic = NULL, subtopic = NULL, type = NULL,
  extra_args = NULL, tidy = TRUE, tidy_style = "snake_case",
  verbose = FALSE)

hansard_research_briefings(topic = NULL, subtopic = NULL, type = NULL,
  extra_args = NULL, tidy = TRUE, tidy_style = "snake_case",
  verbose = FALSE)

Arguments

topic

The topic of the parliamentary briefing. Defaults to NULL.

subtopic

The subtopic of the parliamentary briefing. Defaults to NULL.

type

The type of research briefing. 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 details on parliamentary research briefings on the given topic.

See Also

research_subtopics_list

research_types_list

research_topics_list

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
## Not run: 
x <- research_briefings('Housing and planning')

# Requests can be made using lists created using `research_topics_list`
# and `research_subtopics_list`

research_topics_list <- research_topics_list()

x <- research_briefings(topic = research_topics_list[[7]])

research_subtopics_list <- research_subtopics_list()

x <- research_briefings(subtopic = research_subtopics_list[[7]][10])

# Requests for certain briefing types can also be made using lists
# created with `research_types_list`.

research_types_list <- research_types_list()

x <- research_briefings(type = research_types_list[[3]])

## End(Not run)

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