get_paginated_data {ukhsadatR} | R Documentation |
Get Paginated Data
Description
Generates API query URL and retrieves paginated data.
Usage
get_paginated_data(
theme = NULL,
sub_theme = NULL,
topic = NULL,
geography_type = NULL,
geography = NULL,
metric = NULL,
page_number = 1,
page_size = 365
)
Arguments
theme |
the largest overall topical subgroup of data. For
example |
sub_theme |
a topical subgroup associated with the parent theme.
For example |
topic |
categorical subgroup associated with the selected
theme and sub_theme. For example, |
geography_type |
the overarching area type for the intended geography.
For example |
geography |
the selected area under the |
metric |
the type of data being selected.
For example |
page_number |
define which page of data to retrieve |
page_size |
define number of results returned per page. Maximum supported size is 365. |
Details
If any input argument is left NULL or invalid, a list of possible values for that parameter is returned.
Value
list containing the query structure and results
Examples
data <- get_paginated_data(
theme = "infectious_disease",
sub_theme = "respiratory",
topic = "COVID-19",
geography_type = "Nation",
geography = "England",
metric = "COVID-19_cases_casesByDay",
page_number = 2
)
[Package ukhsadatR version 0.1.0 Index]