NHSDatasetProvider: NHS datasets

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

Description

NHS datasets

NHS datasets

Super classes

ukcovidtools::PassthroughFilesystemCache -> ukcovidtools::DataProvider -> ukcovidtools::CovidTimeseriesProvider -> NHSDatasetProvider

Methods

Public methods

• NHSDatasetProvider$new()

• NHSDatasetProvider$getGoogleMobility()

• NHSDatasetProvider$getSignificantDates()

• NHSDatasetProvider$getPublicOneOneOne()

• NHSDatasetProvider$getTomWhiteCases()

• NHSDatasetProvider$getTomWhiteIndicators()

• NHSDatasetProvider$getNHSDeaths()

• NHSDatasetProvider$getPHEDashboard()

• NHSDatasetProvider$getPHEApiNations()

• NHSDatasetProvider$getPHEApiNHSRegions()

• NHSDatasetProvider$getPHEApiNHSTrusts()

• NHSDatasetProvider$getPHEPaginatedData()

• NHSDatasetProvider$getPHEApi()

• NHSDatasetProvider$getCLIMB()

• NHSDatasetProvider$getCOGUK()

• NHSDatasetProvider$getTiers()

• NHSDatasetProvider$getTheFireHose()

• NHSDatasetProvider$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()

• ukcovidtools::CovidTimeseriesProvider$complete()

• ukcovidtools::CovidTimeseriesProvider$completeAllRegions()

• ukcovidtools::CovidTimeseriesProvider$describe()

• ukcovidtools::CovidTimeseriesProvider$describeErrors()

• ukcovidtools::CovidTimeseriesProvider$fillAbsent()

• ukcovidtools::CovidTimeseriesProvider$fillAbsentAllRegions()

• ukcovidtools::CovidTimeseriesProvider$fillAbsentByRegion()

• ukcovidtools::CovidTimeseriesProvider$fixDatesAndNames()

• ukcovidtools::CovidTimeseriesProvider$setTruncation()

• ukcovidtools::CovidTimeseriesProvider$timeseriesQA()

• ukcovidtools::CovidTimeseriesProvider$trimNAs()

---

Method new()

Usage

NHSDatasetProvider$new(providerController, ...)

---

Method getGoogleMobility()

Load google mobility file aligned with LAD codes

Usage

NHSDatasetProvider$getGoogleMobility(...)

Returns

google mobility 0 custom format

---

Method getSignificantDates()

Load curated significant dates file

Usage

NHSDatasetProvider$getSignificantDates(signif = Inf, ...)

Returns

public 111 data including pathways and online, pre and post april. Codes are CCG20 codes.

---

Method getPublicOneOneOne()

Load public 111 summary file

Usage

NHSDatasetProvider$getPublicOneOneOne(...)

Returns

public 111 data including pathways and online, pre and post april. Codes are CCG20 codes.

---

Method getTomWhiteCases()

Usage

NHSDatasetProvider$getTomWhiteCases(truncate = 4, ...)

---

Method getTomWhiteIndicators()

Usage

NHSDatasetProvider$getTomWhiteIndicators(truncate = 4, ...)

---

Method getNHSDeaths()

Usage

NHSDatasetProvider$getNHSDeaths(truncate = 7, ...)

---

Method getPHEDashboard()

Get UK outbreak timeseries data

Usage

NHSDatasetProvider$getPHEDashboard(truncate = 4, ...)

Returns

a covidTimeserisFormat data frame with several timeseries in it Extracts paginated data by requesting all of the pages and combining the results.

---

Method getPHEApiNations()

Usage

NHSDatasetProvider$getPHEApiNations(...)

---

Method getPHEApiNHSRegions()

Usage

NHSDatasetProvider$getPHEApiNHSRegions(...)

---

Method getPHEApiNHSTrusts()

Usage

NHSDatasetProvider$getPHEApiNHSTrusts(...)

---

Method getPHEPaginatedData()

Usage

NHSDatasetProvider$getPHEPaginatedData(filters, structure)

Arguments

filters

API filters. See the API documentations for additional information.

structure

Structure parameter. See the API documentations for additional information.

Returns

list Comprehensive list of dictionaries containing all the data for the given “filter“ and “structure'.'

---

Method getPHEApi()

Usage

NHSDatasetProvider$getPHEApi(
  areaType = "nation",
  areaName = NULL,
  areaCode = NULL,
  truncate = 4,
  ...
)

---

Method getCLIMB()

Usage

NHSDatasetProvider$getCLIMB(...)

---

Method getCOGUK()

Usage

NHSDatasetProvider$getCOGUK(...)

---

Method getTiers()

Usage

NHSDatasetProvider$getTiers(...)

---

Method getTheFireHose()

Usage

NHSDatasetProvider$getTheFireHose(...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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