tableCharacteristics: Format a summarise_characteristics object into a visual...

In CohortCharacteristics: Summarise and Visualise Characteristics of Patients in the OMOP CDM

Format a summarise_characteristics object into a visual table.

Description

Usage

tableCharacteristics(
  result,
  type = "gt",
  header = c("cdm_name", "cohort_name"),
  groupColumn = NULL,
  hide = character()
)

Arguments

result	A summarised_result object. Output of summariseCharacteristics().
type	Type of table. Check supported types with visOmopResults::tableType().
header	Columns to use as header. See options with tidyColumns(result).
groupColumn	Columns to group by. See options with tidyColumns(result).
hide	Columns to hide from the visualisation. See options with tidyColumns(result).

Value

A table with a formatted version of the summariseCharacteristics result.

Examples

library(CohortCharacteristics)

cdm <- mockCohortCharacteristics()

result <- summariseCharacteristics(cdm$cohort1)

tableCharacteristics(result)

mockDisconnect(cdm)

CohortCharacteristics documentation built on Oct. 1, 2024, 5:08 p.m.