tv_programmes: TV broadcast data

Description Usage Arguments Value TV Programme functions Examples

View source: R/tv_programmes.R

Description

Imports data on TV broadcasts, clips of individual members and parliamentary TV channels.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
tv_programmes(legislature = NULL, start_date = "1900-01-01",
  end_date = Sys.Date(), extra_args = NULL, tidy = TRUE,
  tidy_style = "snake_case", verbose = TRUE)

hansard_tv_programmes(legislature = NULL, start_date = "1900-01-01",
  end_date = Sys.Date(), extra_args = NULL, tidy = TRUE,
  tidy_style = "snake_case", verbose = TRUE)

tv_clips(mp_id = NULL, start_date = "1900-01-01", end_date = Sys.Date(),
  extra_args = NULL, tidy = TRUE, tidy_style = "snake_case",
  verbose = TRUE)

hansard_tv_clips(mp_id = NULL, start_date = "1900-01-01",
  end_date = Sys.Date(), extra_args = NULL, tidy = TRUE,
  tidy_style = "snake_case", verbose = TRUE)

tv_channels(tidy = TRUE, tidy_style = "snake_case", verbose = TRUE)

hansard_tv_channels(tidy = TRUE, tidy_style = "snake_case",
  verbose = TRUE)

Arguments

legislature

Accepts one of either 'commons' or 'lords'. If NULL, returns all TV programmes for all chambers.

start_date

Only includes broadcasts on or after this date. Accepts character values in 'YYYY-MM-DD' format, and objects of class Date, POSIXt, POSIXct, POSIXlt or anything else that can be coerced to a date with as.Date(). Defaults to '1900-01-01'.

end_date

Only includes broadcasts on or before this date. Accepts character values in 'YYYY-MM-DD' format, and objects of class Date, POSIXt, POSIXct, POSIXlt or anything else that can be coerced to a date with as.Date(). Defaults to the current system date.

extra_args

Additional parameters and queries to pass to API. These queries must be strings and start with "&". 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, displayes messages on the console on the progress of the API request. Defaults to TRUE.

mp_id

Accepts the ID of an MP or peer, and returns all clips featuring that MP or peer. If NULL, returns data on all available clips. Defaults to NULL.

Value

A tibble with details on TV broadcasts.

A tibble with details on TV broadcasts featuring the given MP, or all available clips.

A tibble with details on the different broadcasting channels.

TV Programme functions

tv_programmes

TV programmse broadcast, per legislature and date

tv_clips

Clips of a given MP or Peer

tv_channels

Details on the different parliamentary TV channels

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
x <- tv_programmes('commons', start_date ='2016-11-01',
                   end_date='2016-12-01')

## End(Not run)
## Not run: 
x <- tv_clips(4591)

## End(Not run)

EvanOdell/hansard documentation built on July 19, 2018, 3:09 p.m.