Pin column filters for the session

Overrides the default column filters defined in table metadata. Pinned filters persist until cleared with codeminer_clear_col_filters() or codeminer_disconnect().

Usage

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

Arguments

lookup

Named list of column filters for lookup tables, keyed by code type. Each value is a named list of column_name = c(values) pairs. E.g. list("SNOMED CT" = list(active_concept = c("1"))).

relationship

Named list of column filters for relationship tables, keyed by code type.

mapping

Named list of column filters for mapping tables, keyed by "from > to" pairs. E.g. list("Read 3 > ICD-10" = list(mapping_status = c("E", "G"))).

Value

The current pinned col_filters (a list), invisibly.

Details

Pinned filters only affect col_filters = "default" resolution. Explicit col_filters arguments on query functions always take precedence.

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

See also

with_col_filters(), codeminer_clear_col_filters()

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

Examples

if (FALSE) { # \dontrun{
# Pin lookup filters — only return active SNOMED concepts
codeminer_set_col_filters(
  lookup = list("SNOMED CT" = list(active_concept = c("1")))
)

# Pin mapping filters
codeminer_set_col_filters(
  mapping = list("Read 3 > ICD-10" = list(mapping_status = c("E", "G")))
)

# Clear all filter pins
codeminer_clear_col_filters()
} # }