stratifyByBrand: Stratify a codelist by brand category.

In CodelistGenerator: Identify Relevant Clinical Codes and Evaluate Their Use

Stratify a codelist by brand category.

Description

Stratify a codelist by brand category.

Usage

stratifyByBrand(
  x,
  cdm,
  nameStyle = "{codelist_name}_{brand}",
  keepOriginal = FALSE
)

Arguments

x	A codelist.
cdm	A cdm reference to an OMOP CDM dataset. If data is held within a database, the vocabulary tables should be in the same schema as the clinical tables (person, observation period, and so on).
nameStyle	Naming of the new codelists, use {codelist_name} to include the codelist name and {brand} to include the brand name.
keepOriginal	Whether to keep the original codelist (TRUE) or just return the stratified ones (FALSE).

Value

The codelist with the required stratifications, as different elements of the list.

Examples

library(CodelistGenerator)

cdm <- mockVocabRef()
codes <- newCodelist(list(
  concepts_1 = c(20L, 21L, 22L),
  concepts_2 = c(10L, 13L, 21L)
))

new_codes <- stratifyByBrand(x = codes,
                             cdm = cdm,
                             keepOriginal = TRUE)
new_codes

CodelistGenerator documentation built on Dec. 17, 2025, 5:06 p.m.