DataProvider: Caching and dataset management

In terminological/uk-covid-datatools: Functions for sourcing, cleaning and calculating Rt for uk covid timeseries data

Description

Caching and dataset management

Caching and dataset management

Super class

ukcovidtools::PassthroughFilesystemCache -> DataProvider

Methods

Public methods

• DataProvider$new()

• DataProvider$downloadAndUnzip()

• DataProvider$downloadAndUntar()

• DataProvider$download()

• DataProvider$downloadDaily()

• DataProvider$normaliseGender()

• DataProvider$normaliseAgeCat()

• DataProvider$cutByAge()

• DataProvider$breakFromCats()

• DataProvider$labelsFromBreaks()

• DataProvider$ageCatToFactor()

• DataProvider$ageToAgeCat()

• DataProvider$clone()

Inherited methods

• ukcovidtools::PassthroughFilesystemCache$getDaily()

• ukcovidtools::PassthroughFilesystemCache$getHashCached()

• ukcovidtools::PassthroughFilesystemCache$getSaved()

• ukcovidtools::PassthroughFilesystemCache$unloadCache()

---

Method new()

New provider pipeline

Usage

DataProvider$new(providerController, ...)

Arguments

providerController

the provider controller

...

for compatibility

Returns

the provider

---

Method downloadAndUnzip()

Usage

DataProvider$downloadAndUnzip(id, url, pattern)

---

Method downloadAndUntar()

Usage

DataProvider$downloadAndUntar(id, url, pattern)

---

Method download()

Usage

DataProvider$download(id, url, type = "csv")

---

Method downloadDaily()

Usage

DataProvider$downloadDaily(id, url, type = "csv")

---

Method normaliseGender()

Usage

DataProvider$normaliseGender(gender, na.value = NA_character_)

---

Method normaliseAgeCat()

Usage

DataProvider$normaliseAgeCat(ageCat)

---

Method cutByAge()

Usage

DataProvider$cutByAge(age, ageBreaks = NULL)

---

Method breakFromCats()

Usage

DataProvider$breakFromCats(ageCat)

---

Method labelsFromBreaks()

Usage

DataProvider$labelsFromBreaks(ageBreaks)

---

Method ageCatToFactor()

ordered factor from age range labels

Usage

DataProvider$ageCatToFactor(
  ageCat,
  ageLabels = c("0-4", "<5", "5-9", "5-14", "10-14", "15-19", "15-24", "20-24", "25-29",
    "25-34", "30-34", "35-39", "35-44", "40-44", "45-49", "45-54", "50-54", "55-59",
    "55-64", "60-64", "65-69", "65-74", "70-74", "75-79", "75-84", "80+", "85+",
    "unknown")
)

Arguments

ageCat

- a vector of age categories as strings

ageLabels

- a vector of age range labels

Returns

an ordered factor of age categories

---

Method ageToAgeCat()

create an ordered factor of ages from a continuous age

Usage

DataProvider$ageToAgeCat(
  age,
  ageLabels = c("0-4", "5-9", "10-14", "15-19", "20-24", "25-29", "30-34", "35-39",
    "40-44", "45-49", "50-54", "55-59", "60-64", "65-69", "70-74", "75-79", "80+")
)

Arguments

age

- a vector of ages

ageLabels

- a vector of age range labels

Returns

an ordered factor of age categories

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DataProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

terminological/uk-covid-datatools documentation built on June 24, 2021, 8:16 p.m.