Description Usage Arguments Value See Also Examples
View source: R/get_regional_data.R
Provides an interface to source specific classes which
support regional level data. For simple use cases this allows downloading
clean, standardised, regional-level COVID-19 data sets. Internally this uses
the DataClass()
parent class which allows documented downloading, cleaning,
and processing. Optionally all steps of data processing can be returned
along with the functions used for processing but by default just the
finalised processed data is returned. See the examples for some potential
use cases and the links to lower level functions for more details and
options.
1 2 3 4 5 6 7 8 9 10 11 |
country |
A character string specifying the country to get data from.
Not case dependent. Name should be the English name. For a list of
options use |
level |
A character string indicating the target administrative level
of the data with the default being "1". Currently supported options are
level 1 ("1) and level 2 ("2"). Use |
totals |
Logical, defaults to FALSE. If TRUE, returns totalled data per region up to today's date. If FALSE, returns the full dataset stratified by date and region. |
localise |
Logical, defaults to TRUE. Should region names be localised. |
steps |
Logical, defaults to FALSE. Should all processing and cleaning steps be kept and output in a list. |
class |
Logical, defaults to FALSE. If TRUE returns the
|
verbose |
Logical, defaults to |
regions |
A character vector of target regions to be assigned to the
|
... |
Additional arguments to pass to class specific functionality. |
A tibble with data related to cases, deaths, hospitalisations, recoveries and testing stratified by regions within the given country.
Data interface functions
CountryDataClass
,
DataClass
,
get_available_datasets()
,
get_national_data()
,
initialise_dataclass()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | ## Not run:
# set up a data cache
start_using_memoise()
# download data for Italy
get_regional_data("italy")
# return totals for Italy with no localisation
get_regional_data("italy", localise = FALSE, totals = TRUE)
# download data for the UK but return the class
uk <- get_regional_data("United Kingdom", class = TRUE)
uk
# return UK data from the class object]
uk$return()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.