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(
col_filters = NULL,
lookup = NULL,
relationship = NULL,
mapping = NULL
)Arguments
- col_filters
A whole type-layered filter object — the shape returned by
get_col_filters(), i.e.list(lookup =, relationship =, mapping =)— orNAto disable all filtering (pins and metadata defaults) for the session. Cannot be combined with the per-type 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, orNAto un-filter that table. 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"))).
Details
A pin replaces the metadata-defined default filters for its table
wholesale (it does not merge column-by-column) — a message lists any
default columns the pin drops. To tweak one column while keeping the
rest, amend get_col_filters() output and pin that.
Pinned filters apply when queries run with col_filters = "default"; an
explicit col_filters argument on a query function overrides the pin for
that call (again whole-key, per table).
New pins are merged with existing ones by table key. To replace all pins,
call codeminer_clear_col_filters() first. Pins that match no registered
table, column, or value trigger a warning.
See also
with_col_filters(), codeminer_clear_col_filters(),
get_col_filters()
Other Workbench management:
codeminer_clear_col_filters(),
codeminer_clear_versions(),
codeminer_connect(),
codeminer_disconnect(),
codeminer_refresh_cache(),
codeminer_set_version(),
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")))
)
# Amend the registered defaults and pin the result
cf <- get_col_filters()
cf$lookup[["SNOMED CT"]]$moduleId_concept <- "999000011000001104"
codeminer_set_col_filters(col_filters = cf)
# Disable all filtering for the session
codeminer_set_col_filters(NA)
# Clear all filter pins (back to metadata defaults)
codeminer_clear_col_filters()
} # }