OmopSketch (version 1.0.0)

tableTopConceptCounts: Create a visual table of the most common concepts from summariseConceptIdCounts() output

Description

This function takes a summarised_result object and generates a formatted table highlighting the most frequent concepts.

Usage

tableTopConceptCounts(
  result,
  top = 10,
  countBy = NULL,
  type = NULL,
  style = NULL
)

Value

A formatted table visualisation.

Arguments

result

A summarised_result object (output of summariseConceptIdCounts()).

top

Integer. The number of top concepts to display. Defaults to 10.

countBy

Either 'person' or 'record'. If NULL whatever is in the data is used.

type

Character string specifying the desired output table format. See visOmopResults::tableType() for supported table types. If type = NULL, global options (set via visOmopResults::setGlobalTableOptions()) will be used if available; otherwise, a default 'gt' table is created.

style

Defines the visual formatting of the table. This argument can be provided in one of the following ways:

1. Pre-defined style: Use the name of a built-in style (e.g., "darwin"). See visOmopResults::tableStyle() for available options.

2. YAML file path: Provide the path to an existing .yml file defining a new style.

3. List of custome R code: Supply a block of custom R code or a named list describing styles for each table section. This code must be specific to the selected table type.

If style = NULL, the function will use global options (seevisOmopResults::setGlobalTableOptions()) or a _brand.yml file (if found); otherwise, the default style is applied.

Examples

# \donttest{
library(OmopSketch)
library(omock)

cdm <- mockCdmFromDataset(datasetName = "GiBleed", source = "duckdb")

result <- summariseConceptIdCounts(cdm = cdm, omopTableName = "condition_occurrence")

tableTopConceptCounts(result = result, top = 5)

cdmDisconnect(cdm = cdm)
# }