Skip to contents

Get Read 2 coding system files from NHS TRUD

Source: R/get_read2_trud.R
get_read2_trud.Rd

Downloads the NHS Data Migration release (TRUD item 9), which contains the Read V2 lookup and Read 2/CTV3 cross-mapping files.

Usage

get_read2_trud(
  dir_path = tempdir(),
  release = "latest",
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

dir_path

Directory path to download to. Defaults to tempdir().

release

Character string specifying which release to download. Can be:

  • "latest" (default) — downloads the most recent release

  • A specific release identifier string

overwrite

Logical. If TRUE, re-downloads and overwrites existing files. Default is FALSE.

quiet

Logical. If TRUE, suppresses informational messages. Default is FALSE.

Value

File path to the downloaded NHS Data Migration zip file (invisibly).

Details

This is a convenience wrapper around get_nhs_data_migration(), since both the Read 2 files and the NHS Data Migration mapping tables come from the same TRUD item.

This function requires a valid NHS TRUD API key set as the environment variable TRUD_API_KEY. You must also be subscribed to item 9 on the NHS TRUD website.

See also

read_read2_trud(), add_read2_trud(), get_nhs_data_migration()

Examples

if (FALSE) { # \dontrun{
path <- get_read2_trud()
read_read2_trud(path)
} # }