Pin table versions for the session

Overrides the default "latest" version resolution for lookup, relationship, and/or mapping tables. Pinned versions persist until cleared with codeminer_clear_versions() or codeminer_disconnect().

Usage

codeminer_set_version(lookup = NULL, relationship = NULL, mapping = NULL)

Arguments

lookup

Named character vector of lookup versions, keyed by code type. E.g. c("ICD-10" = "v42", "Read 3" = "v1").

relationship

Named character vector of relationship versions, keyed by code type.

mapping

Named character vector of mapping versions, keyed by "from > to" pairs. E.g. c("Read 3 > ICD-10" = "v1").

Value

The current pinned versions (a list), invisibly.

Details

Pinned versions only affect "latest" resolution. Explicit version arguments on query functions (e.g. CODES(..., lookup_version = "v1")) always take precedence.

Versions are also auto-cached the first time "latest" is resolved for a given code type. Calling codeminer_set_version() overrides any auto-cached version.

New pins are merged with existing ones. To replace all pins, call codeminer_clear_versions() first.

See also

Other Workbench management: codeminer_clear_col_filters(), codeminer_clear_versions(), codeminer_connect(), codeminer_disconnect(), codeminer_refresh_cache(), codeminer_set_col_filters(), codeminer_snapshot_extra(), codeminer_status(), default_col_filters(), get_col_filters(), with_col_filters()

Examples

if (FALSE) { # \dontrun{
# Pin lookup versions for multiple code types
codeminer_set_version(
  lookup = c("ICD-10" = "v42", "Read 3" = "v1")
)

# Pin mapping version for a specific pair
codeminer_set_version(
  mapping = c("Read 3 > ICD-10" = "v1")
)

# Clear all pins
codeminer_clear_versions()
} # }