FUNCTION_TITLE

Source: R/query.R

FUNCTION_DESCRIPTION

queryDescendants(
  ancestor_concept_ids,
  vocab_schema,
  min_levels_of_separation = NULL,
  max_levels_of_separation = NULL,
  conn = NULL,
  cache_only = FALSE,
  skip_cache = FALSE,
  override_cache = FALSE,
  render_sql = FALSE,
  verbose = FALSE,
  sleepTime = 1
)

Arguments

ancestor_concept_ids

PARAM_DESCRIPTION
vocab_schema

PARAM_DESCRIPTION
min_levels_of_separation

PARAM_DESCRIPTION, Default: NULL
max_levels_of_separation

PARAM_DESCRIPTION, Default: NULL
conn

Connection object. If provided, diverts queries to the connection instead of the local Athena instance without caching features.
cache_only

Loads from the cache and does not query the database. A NULL object is returned if a resultset was not cached.
skip_cache

Skip the caching altogether and directly query the database.
override_cache

If TRUE, the cache will not be loaded and will be overwritten by a new query. For override_cache to take effect, skip_cache should be FALSE.
render_sql

If TRUE, the SQL will be printed back in the console prior to execution. Default: FALSE
verbose

If TRUE, prints loading and querying operations messages to the console. Default: FALSE
sleepTime

Argument for `Sys.sleep()` in between queries to allow for halting function execution, especially in cases where other chariot functions are executing multiple queries in succession and require cancellation.

Value

a [tibble][tibble::tibble-package]

See also

render

Other query functions: queryAncestors(), queryAthena(), queryCDM(), queryCode(), queryConceptClassRelationships(), queryConceptId(), queryRelationships(), querySynonyms(), queryVocabularyRelationships()