Skip to contents

Reads Read V2 lookup and relationship files from the NHS Read Browser release (TRUD item 8) and adds them to the active CodeMiner database. This is a convenience wrapper around read_read2_trud() that automatically calls add_lookup_table() and add_relationship_table().

Usage

add_read2_trud(
  path = get_read2_trud(),
  tables = c("read2_lkp", "read2_relationship"),
  version = NULL,
  source =
    "https://isd.digital.nhs.uk/trud/users/authenticated/filters/0/categories/9/items/8/releases"
)

Arguments

path

Path to the NHS Read Browser release (zip file or unzipped directory). Default uses get_read2_trud() to download the latest release.

tables

Character vector of table names to add. See read_read2_trud() for available tables. By default, adds both tables.

version

Character string for the version label. If NULL (default), derived from the zip file or directory name.

source

Character string for the data source URL or description.

Value

Invisibly returns the result from read_read2_trud() (a named list of tables with metadata).

Details

The Read 2 ↔ CTV3 cross-mapping tables (rctctv3map_uk, ctv3rctmap_uk) live in TRUD item 9 and are added via add_nhs_data_migration().

Examples

if (FALSE) { # \dontrun{
build_database(db_path = "my_codes.db")
add_read2_trud()
add_read2_trud(tables = "read2_lkp")
} # }