tableAchillesCodeUse: Format the result of summariseAchillesCodeUse into a table.

In CodelistGenerator: Identify Relevant Clinical Codes and Evaluate Their Use

Format the result of summariseAchillesCodeUse into a table.

Description

Format the result of summariseAchillesCodeUse into a table.

Usage

tableAchillesCodeUse(
  result,
  type = "gt",
  header = c("cdm_name", "estimate_name"),
  groupColumns = character(),
  hide = character(),
  .options = list(),
  conceptId = lifecycle::deprecated(),
  standard = lifecycle::deprecated(),
  vocabulary = lifecycle::deprecated(),
  excludeColumns = lifecycle::deprecated()
)

Arguments

result	A ⁠<summarised_result>⁠ with results of the type "achilles_code_use".
type	Type of desired formatted table. To see supported formats use visOmopResults::tableType()
header	A vector specifying the elements to include in the header. The order of elements matters, with the first being the topmost header. The header vector can contain one of the following variables: "cdm_name", "codelist_name", "domain_id", "standard_concept_name", "standard_concept_id", "estimate_name", "standard_concept", "vocabulary_id". Alternatively, it can include other names to use as overall header labels.
groupColumns	Variables to use as group labels. Allowed columns are: "cdm_name", "codelist_name", "domain_id", "standard_concept_name", "standard_concept_id", "estimate_name", "standard_concept", "vocabulary_id". These cannot be used in header.
hide	Table columns to exclude, options are: "cdm_name", "codelist_name", "domain_id", "standard_concept_name", "standard_concept_id", "estimate_name", "standard_concept", "vocabulary_id". These cannot be used in header or groupColumn.
.options	Named list with additional formatting options. visOmopResults::tableOptions() shows allowed arguments and their default values.
conceptId	Deprecated.
standard	Deprecated.
vocabulary	Deprecated.
excludeColumns	Deprecated.

Value

A table with a formatted version of the summariseCohortCodeUse result.

Examples

cdm <- mockVocabRef("database")
oa <- getCandidateCodes(cdm = cdm, keywords = "osteoarthritis")
result_achilles <- summariseAchillesCodeUse(list(oa = oa$concept_id), cdm = cdm)
tableAchillesCodeUse(result_achilles)
CDMConnector::cdmDisconnect(cdm)

CodelistGenerator documentation built on Oct. 17, 2024, 5:09 p.m.