get_available_datasets: Get supported data sets

In epiforecasts/covidregionaldata: Subnational Data for COVID-19 Epidemiology

Get supported data sets

Description

Returns data on what countries are available from the data provided with this package either using a cached dataset or built by searching the target namespace.

Usage

get_available_datasets(type, render = FALSE, namespace = "covidregionaldata")

Arguments

type	A character vector indicating the types of data to return. Current options include "national" (which are datasets at the national level which inherit from CountryDataClass) and "regional" (which are datasets at the regional level which inherit directly from DataClass()).
render	Logical If TRUE the supported data set table is built from the available classes using summary methods. If FALSE the supported data set table is taken from package data. Defaults to FALSE.
namespace	Character string The name of the namespace to search for class objects. Defaults to "covidregionaldata" as the package.

Value

A list of available data sets and the spatial aggregation data is available for.

See Also

Data interface functions CountryDataClass, DataClass, get_national_data(), get_regional_data(), initialise_dataclass()

Examples

# see all available datasets
get_available_datasets()

# see only national level datasets
get_available_datasets("national")

# see only regional level datasets
get_available_datasets("regional")

# render the data
get_available_datasets(render = TRUE)

epiforecasts/covidregionaldata documentation built on June 26, 2022, 1 a.m.