Skip to contents

Read OPCS-4 coding files into R

Source: R/read_opcs4_trud.R
read_opcs4_trud.Rd

Reads the OPCS-4 codes and descriptions from a local copy of the TRUD release files.

Usage

read_opcs4_trud(
  path,
  version = NULL,
  source = "https://isd.digital.nhs.uk/trud/"
)

Arguments

path

Path to the OPCS-4 release. Can be:

  • A zip file (e.g., from get_opcs4_trud())

  • An unzipped directory containing the codes and titles file

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

A named list with elements:

  • opcs4_lkp: lookup table with table (data.table) and metadata

  • opcs4_relationship: parent-child hierarchy derived from code structure

The lookup table has columns opcs4_code (dot-stripped), opcs4_code_dotted (original format with dot), and description.

See also

add_opcs4_trud(), get_opcs4_trud()

Examples

if (FALSE) { # \dontrun{
path <- get_opcs4_trud()
result <- read_opcs4_trud(path)
result$opcs4_lkp$lookup$table
} # }