consistent-doc: Helper for consistent documentation

In OmopSketch: Characterise Tables of an OMOP Common Data Model Instance

Helper for consistent documentation

Description

Helper for consistent documentation

Arguments

cdm	A cdm_reference object. Use CDMConnector to create a reference to a database or omock to create a reference to synthetic data.
omopTableName	A character vector of the names of the tables to summarise in the cdm object. Run clinicalTables() to check the available options.
ageGroup	A list of age groups to stratify the results by. Each element represents a specific age range. You can give them specific names, e.g. ageGroup = list(children = c(0, 17), adult = c(18, Inf)).
sex	Logical; whether to stratify results by sex (TRUE) or not (FALSE).
facet	Columns to face by. Formula format can be provided. See possible columns to face by with: visOmopResults::tidyColumns().
colour	Columns to colour by. See possible columns to colour by with: visOmopResults::tidyColumns().
interval	Time interval to stratify by. It can either be "years", "quarters", "months" or "overall".
sample	Either an integer or a character string. If an integer (n > 0), the function will first sample n distinct person_ids from the person table and then subset the input tables to those subjects. If a character string, it must be the name of a cohort in the cdm; in this case, the input tables are subset to subjects (subject_id) belonging to that cohort. Use NULL to disable subsetting (default value).

OmopSketch documentation built on Aug. 27, 2026, 5:07 p.m.