Skip to contents

Get Read 3 (CTV3) coding system files from NHS TRUD

Source: R/get_read3_trud.R
get_read3_trud.Rd

Downloads the Read Codes Version 3 (CTV3) release (TRUD item 19) from NHS TRUD.

Usage

get_read3_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 Read 3 zip file (invisibly).

Details

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

See also

read_read3_trud(), add_read3_trud()

Examples

if (FALSE) { # \dontrun{
path <- get_read3_trud()
read_read3_trud(path)
} # }