CodelistGenerator (version 3.3.2)

getDescendants: getDescendants

Description

getDescendants

Usage

getDescendants(
  cdm,
  conceptId,
  withAncestor = FALSE,
  ingredientRange = c(0, Inf),
  doseForm = NULL
)

Value

The descendants of a given concept id

Arguments

cdm

cdm_reference via CDMConnector

conceptId

concpet_id to search

withAncestor

If TRUE, return column with ancestor. In case of multiple ancestors, concepts will be separated by ";"

ingredientRange

Used to restrict descendant codes to those associated with a specific number of drug ingredients. Must be a vector of length two with the first element the minimum number of ingredients allowed and the second the maximum. A value of c(2, 2) would restrict to only concepts associated with two ingredients.

doseForm

Only descendants codes with the specified drug dose form will be returned. If NULL, descendant codes will be returned regardless of dose form.

Examples

# \donttest{
cdm <- mockVocabRef()
getDescendants(cdm = cdm, conceptId = 1)
# }