get_data {ukhsadatR} | R Documentation |
Get Data
Description
Iteratively runs get_paginated_data
to download all results and
combine them into a data.frame
.
Usage
get_data(
theme = NULL,
sub_theme = NULL,
topic = NULL,
geography_type = NULL,
geography = NULL,
metric = NULL
)
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 |
Details
For further information on the UKHSA dashboard API please visit the API documentation.
If any input argument is left NULL or invalid, a list of possible values for that parameter is returned.
Value
data.frame containing the query results
Examples
get_data(
theme = "infectious_disease",
sub_theme = "respiratory",
topic = "COVID-19",
geography_type = "Nation",
geography = "England",
metric = "COVID-19_cases_casesByDay"
)
[Package ukhsadatR version 0.1.1 Index]