epetition: Individual epetitions

Description Usage Arguments Value See Also Examples

View source: R/epetition.R

Description

Imports data on a given epetition. For bulk epetion data, see epetition_tibble.

Usage

1
2
3
4
5
epetition(ID = NULL, by_constituency = FALSE, extra_args = NULL,
  tidy = TRUE, tidy_style = "snake_case", verbose = FALSE)

hansard_epetition(ID = NULL, by_constituency = FALSE, extra_args = NULL,
  tidy = TRUE, tidy_style = "snake_case", verbose = FALSE)

Arguments

ID

The ID of a given petition. If NULL, returns all epetitions. Defaults to NULL. See epetition_tibble for a greater degree of flexibility when querying all epetitions.

by_constituency

Accepts either TRUE or FALSE. If TRUE, provides a tibble with a breakdown of signatures for each petition, by constituency. Defaults to FALSE.

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 electronic petitions submitted to parliament.

See Also

epetition_tibble

Examples

1
2
3
4
## Not run: 
x <- epetition(ID = 706964, by_constituency=TRUE)

## End(Not run)

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