Returns a lazy dplyr::tbl() containing the lookup table with standardised
column names (code, description, code_type, preferred_description,
category) plus all additional columns from the underlying database table.
Call dplyr::collect() to materialise the result.
Usage
get_lookup_table(
type,
codes = NULL,
lookup_version = "latest",
col_filters = "default",
con = NULL,
meta = NULL,
rowid_range = NULL,
call = rlang::caller_env()
)Arguments
- type
The code type for which to retrieve the lookup table.
- codes
Optional character vector of codes to filter the result to. If
NULL(default), all rows are returned. No warning is emitted for codes that are not present in the table; useCODES()for missing-code warnings.- lookup_version
The version to retrieve. Defaults to
"latest".- col_filters
Column filters to apply. See
CODES()for details.- con
Optional DBI connection. If
NULL(default), uses the workbench connection.- meta
Optional pre-resolved lookup metadata row (as returned by the internal metadata resolver). When supplied, the metadata is not resolved again - callers that have already resolved it pass it through to avoid repeating the resolution. Defaults to
NULL, which resolves the metadata fromtype/lookup_version.- rowid_range
Optional length-2 integer vector
c(from, to)bounding the scan torowid >= from & rowid < toon the underlying table, applied before any other filter so DuckDB can row-group-prune rather than scanning the whole table. Used by the*_CHUNK()functions to bound work per call;NULL(default) scans the whole table as before. Only supported when the "main" database isduckdb_file-backed (seebackend_kind()) -rowidis not addressable through the views the other two backend shapes use.- call
The calling environment. Passed to codeminer_abort.
Value
A lazy dplyr::tbl() with standardised columns (code,
description, code_type, preferred_description, category) plus all
other columns from the underlying table. category is NA for code
systems without a populated category source.
Details
This is useful for inspecting columns beyond the standard codelist output
returned by CODES() and DESCRIPTION().
See also
CODES() for standardised codelist output,
get_codeminer_metadata() for discovering available tables.
Other Clinical code lookups and mappings:
CODES(),
CODES_ALL_CHUNK(),
CODES_LIKE_CHUNK(),
DESCRIPTION_CHUNK(),
MAP(),
get_mapping_table(),
get_relationship_table(),
get_relationship_tree()
Examples
create_dummy_database()
#> ✔ Dummy database ready to use!
#> ℹ To reconnect to your previous database:
#> `Sys.setenv(CODEMINER_DB_PATH = "/tmp/Rtmp2UzWkJ/file1c0557d0a915.duckdb")`
#> `codeminer_connect()`
# Get the full ICD-10 lookup table
get_lookup_table("ICD-10") |> dplyr::collect()
#> ℹ Using "UKB v4" as the latest lookup version for "ICD-10".
#> # A tibble: 197 × 15
#> code description ICD10_CODE USAGE USAGE_UK MODIFIER_4 MODIFIER_5 QUALIFIERS
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 A00 Cholera A00 DEFA… 3 NA NA NA
#> 2 A000 Cholera due… A00.0 DEFA… 3 NA NA NA
#> 3 A001 Cholera due… A00.1 DEFA… 3 NA NA NA
#> 4 A009 Cholera, un… A00.9 DEFA… 3 NA NA NA
#> 5 A010 Typhoid fev… A01.0 DEFA… 3 NA NA NA
#> 6 A02 Other salmo… A02 DEFA… 3 NA NA NA
#> 7 A020 Salmonella … A02.0 DEFA… 3 NA NA NA
#> 8 A021 Salmonella … A02.1 DEFA… 3 NA NA NA
#> 9 A022 Localized s… A02.2 DEFA… 3 NA NA NA
#> 10 A028 Other speci… A02.8 DEFA… 3 NA NA NA
#> # ℹ 187 more rows
#> # ℹ 7 more variables: GENDER_MASK <chr>, MIN_AGE <chr>, MAX_AGE <chr>,
#> # TREE_DESCRIPTION <chr>, code_type <chr>, preferred_description <lgl>,
#> # category <chr>
# Filter to specific codes
get_lookup_table("ICD-10", codes = c("E10", "E11")) |> dplyr::collect()
#> # A tibble: 2 × 15
#> code description ICD10_CODE USAGE USAGE_UK MODIFIER_4 MODIFIER_5 QUALIFIERS
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 E10 Type 1 diabe… E10 DEFA… 3 NA NA NA
#> 2 E11 Type 2 diabe… E11 DEFA… 3 NA NA NA
#> # ℹ 7 more variables: GENDER_MASK <chr>, MIN_AGE <chr>, MAX_AGE <chr>,
#> # TREE_DESCRIPTION <chr>, code_type <chr>, preferred_description <lgl>,
#> # category <chr>