CountryDataClass: R6 Class containing national level methods

In covidregionaldata: Subnational Data for COVID-19 Epidemiology

Description

Acts as parent class for national data classes, allowing them to access general methods defined in DataClass() but with additional

Details

On top of the methods documented in DataClass(), this class implements a custom filter function that supports partial matching to English country names using the countrycode package.

Super class

covidregionaldata::DataClass -> CountryDataClass

Public fields

filter_level

Character The level of the data to filter at. Defaults to the country level of the data.

Methods

Public methods

• CountryDataClass$filter()

• CountryDataClass$clone()

Inherited methods

• covidregionaldata::DataClass$available_regions()

• covidregionaldata::DataClass$clean()

• covidregionaldata::DataClass$clean_common()

• covidregionaldata::DataClass$download()

• covidregionaldata::DataClass$download_JSON()

• covidregionaldata::DataClass$get()

• covidregionaldata::DataClass$initialize()

• covidregionaldata::DataClass$process()

• covidregionaldata::DataClass$return()

• covidregionaldata::DataClass$set_region_codes()

• covidregionaldata::DataClass$summary()

• covidregionaldata::DataClass$test()

---

Method filter()

Filter method for country level data. Uses countryname to match input countries with known names.

Usage

CountryDataClass$filter(countries, level)

Arguments

countries

A character vector of target countries. Overrides the current class setting for target_regions. If the filter_level field level argument is set to anything other than level 1 this is passed directly to the parent DataClass() filter() method with no alteration.

level

Character The level of the data to filter at. Defaults to the conuntry level if not specified.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CountryDataClass$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

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

covidregionaldata documentation built on Feb. 7, 2022, 9:07 a.m.