CodelistGenerator (version 3.5.0)

getDescendants: Get descendant codes for a given concept

Description

Get descendant codes for a given concept

Usage

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

Value

The descendants of a given concept id.

Arguments

cdm

A cdm reference via CDMConnector.

conceptId

concept_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 codes with the specified dose form will be returned. If NULL, descendant codes will be returned regardless of dose form. Use 'getDoseForm()' to see the available dose forms.

Examples

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