UKCodeMappingProvider: Process UK ONS code maps

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

Description

Process UK ONS code maps

Process UK ONS code maps

Super classes

ukcovidtools::PassthroughFilesystemCache -> ukcovidtools::DataProvider -> UKCodeMappingProvider

Methods

Public methods

• UKCodeMappingProvider$new()

• UKCodeMappingProvider$getONSMappings()

• UKCodeMappingProvider$getONSRegister()

• UKCodeMappingProvider$getManualMappings()

• UKCodeMappingProvider$getODSMappings()

• UKCodeMappingProvider$getODSCodes()

• UKCodeMappingProvider$getManualCodes()

• UKCodeMappingProvider$getMappings()

• UKCodeMappingProvider$getTransitiveClosure()

• UKCodeMappingProvider$getCodes()

• UKCodeMappingProvider$getDescriptions()

• UKCodeMappingProvider$findCodesByName()

• UKCodeMappingProvider$findNamesByCode()

• UKCodeMappingProvider$allPresentAndCorrect()

• UKCodeMappingProvider$parentCode()

• UKCodeMappingProvider$clone()

Inherited methods

• ukcovidtools::PassthroughFilesystemCache$getDaily()

• ukcovidtools::PassthroughFilesystemCache$getHashCached()

• ukcovidtools::PassthroughFilesystemCache$getSaved()

• ukcovidtools::PassthroughFilesystemCache$unloadCache()

• ukcovidtools::DataProvider$ageCatToFactor()

• ukcovidtools::DataProvider$ageToAgeCat()

• ukcovidtools::DataProvider$breakFromCats()

• ukcovidtools::DataProvider$cutByAge()

• ukcovidtools::DataProvider$download()

• ukcovidtools::DataProvider$downloadAndUntar()

• ukcovidtools::DataProvider$downloadAndUnzip()

• ukcovidtools::DataProvider$downloadDaily()

• ukcovidtools::DataProvider$labelsFromBreaks()

• ukcovidtools::DataProvider$normaliseAgeCat()

• ukcovidtools::DataProvider$normaliseGender()

---

Method new()

Usage

UKCodeMappingProvider$new(providerController, ...)

---

Method getONSMappings()

Usage

UKCodeMappingProvider$getONSMappings(...)

---

Method getONSRegister()

Usage

UKCodeMappingProvider$getONSRegister(...)

---

Method getManualMappings()

Usage

UKCodeMappingProvider$getManualMappings(...)

---

Method getODSMappings()

Usage

UKCodeMappingProvider$getODSMappings(...)

---

Method getODSCodes()

Usage

UKCodeMappingProvider$getODSCodes(...)

---

Method getManualCodes()

Usage

UKCodeMappingProvider$getManualCodes(...)

---

Method getMappings()

Usage

UKCodeMappingProvider$getMappings(...)

---

Method getTransitiveClosure()

Usage

UKCodeMappingProvider$getTransitiveClosure(...)

---

Method getCodes()

Usage

UKCodeMappingProvider$getCodes(...)

---

Method getDescriptions()

Usage

UKCodeMappingProvider$getDescriptions(...)

---

Method findCodesByName()

Get codes from name

Usage

UKCodeMappingProvider$findCodesByName(
  df,
  nameVar = "name",
  outputCodeVar = "code",
  outputCodeTypeVar = "codeType",
  codeTypes = c("LSOA", "CCG", "HB", "LHB", "NHSER", "PHEC", "LAD", "UA", "NHS site",
    "NHS trust", "CTRY", "UK")
)

Arguments

df

a dataframe containing at least a nameVar column

nameVar

the column name of the name to lookup (default "name")

outputCodeVar

the column name of the code to return (default "code")

outputCodeTypeVar

the column name of the codeType to return (default "codeType") or NULL for no codeType column

codeTypes

- a list of codeTypes to constrain the search (or NULL for no restriction)

Returns

a dataframe containing nameVar, outputCodeVar, outputCodeTypeVar

---

Method findNamesByCode()

Get canonical names from code

Usage

UKCodeMappingProvider$findNamesByCode(
  df,
  codeVar = "code",
  outputNameVar = "name",
  outputCodeTypeVar = "codeType",
  codeTypes = NULL
)

Arguments

df

a dataframe containing at least a nameVar column

codeVar

the column name of the code to lookup (default "code")

outputNameVar

the column name of the code to return (default "name")

outputCodeTypeVar

the column name of the name to lookup (default "codeType") or NULL for no codeType column

codeTypes

- a list of codeTypes to constrain the search (or NULL for no restriction)

Returns

a dataframe containing nameVar, outputCodeVar, outputCodeTypeVar

---

Method allPresentAndCorrect()

Usage

UKCodeMappingProvider$allPresentAndCorrect(df, codeVar = "code", codeTypes)

---

Method parentCode()

Usage

UKCodeMappingProvider$parentCode(
  df,
  parentCodeTypes,
  codeVar = "code",
  codeTypeVar = "codeType",
  parentCodeVar = "parentCode",
  parentNameVar = "parentName",
  parentCodeTypeVar = "parentCodeType"
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

UKCodeMappingProvider$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.