UKDemographicsProvider: UK ONS demographics

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

Description

UK ONS demographics

UK ONS demographics

Super classes

ukcovidtools::PassthroughFilesystemCache -> ukcovidtools::DataProvider -> UKDemographicsProvider

Methods

Public methods

• UKDemographicsProvider$new()

• UKDemographicsProvider$getDetailedDemographics()

• UKDemographicsProvider$getDemographicsWithEstimatedEthnicity()

• UKDemographicsProvider$getIMDData()

• UKDemographicsProvider$getDemographicsMap()

• UKDemographicsProvider$getDemographicsForShape()

• UKDemographicsProvider$getDemographicsForCodeTypes()

• UKDemographicsProvider$getDemographicsFromWeightedMapping()

• UKDemographicsProvider$getSingleDigitDemographics()

• UKDemographicsProvider$transitiveClosureWeightedMap()

• UKDemographicsProvider$findDemographics()

• UKDemographicsProvider$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

UKDemographicsProvider$new(providerController, ...)

---

Method getDetailedDemographics()

get the full range of demographics data at most detailed resolution

Usage

UKDemographicsProvider$getDetailedDemographics(...)

---

Method getDemographicsWithEstimatedEthnicity()

Usage

UKDemographicsProvider$getDemographicsWithEstimatedEthnicity(...)

---

Method getIMDData()

Usage

UKDemographicsProvider$getIMDData(...)

---

Method getDemographicsMap()

LSOA & Scottish Data Zones

Usage

UKDemographicsProvider$getDemographicsMap(...)

---

Method getDemographicsForShape()

get demographics interpolated to a specific shape file and aggregated to a given set of age bands, with optionally combining genders

Usage

UKDemographicsProvider$getDemographicsForShape(
  mapId,
  outputShape = self$geog$getMap(mapId),
  outputVars = vars(code, name),
  ageBreaks = seq(5, 90, 5),
  combineGenders = FALSE
)

Arguments

mapId

= the mapId

outputShape

= the sf object containing the shapefile of the desired output which may be grouped by desired output

outputVars

= the desired output columns from the output shapefile enclosed by vars(...) (defaults to code and name)

ageBreaks

= where to cut age groups? e.g. c(15,65,80) (max 90)

combineGenders

= merge the genders

---

Method getDemographicsForCodeTypes()

Usage

UKDemographicsProvider$getDemographicsForCodeTypes(
  codeTypes,
  ageBreaks = seq(5, 90, 5),
  combineGenders = FALSE
)

---

Method getDemographicsFromWeightedMapping()

Usage

UKDemographicsProvider$getDemographicsFromWeightedMapping(
  mappingDf,
  fromCodeVar = "fromCode",
  toCodeVar = "toCode",
  outputCodeVar = "code",
  weightExpr = 1,
  ageBreaks = seq(5, 90, 5),
  combineGenders = FALSE
)

---

Method getSingleDigitDemographics()

Usage

UKDemographicsProvider$getSingleDigitDemographics(
  mappingDf,
  fromCodeVar = "fromCode",
  toCodeVar = "toCode",
  outputCodeVar = "code",
  weightExpr = 1,
  combineGenders = FALSE
)

---

Method transitiveClosureWeightedMap()

Usage

UKDemographicsProvider$transitiveClosureWeightedMap(
  df,
  codeVar = "code",
  codeTypeVar = "codeType",
  ...
)

---

Method findDemographics()

Usage

UKDemographicsProvider$findDemographics(
  df,
  codeVar = "code",
  codeTypeVar = "codeType",
  ageCatVar = "ageCat",
  genderVar = "gender",
  ...
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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