getCohortInclusionStats: Extract the cohort inclusion stats

In OhdsiReportGenerator: Observational Health Data Sciences and Informatics Report Generator

Extract the cohort inclusion stats

Description

This function extracts all cohort inclusion stats for the cohorts of interest.

Usage

getCohortInclusionStats(
  connectionHandler,
  schema,
  cgTablePrefix = "cg_",
  databaseTable = "database_meta_data",
  cohortIds = NULL
)

Arguments

connectionHandler	A connection handler that connects to the database and extracts sql queries. Create a connection handler via 'ResultModelManager::ConnectionHandler$new()'.
schema	The result database schema (e.g., 'main' for sqlite)
cgTablePrefix	The prefix used for the cohort generator results tables
databaseTable	The name of the table with the database details (default 'database_meta_data')
cohortIds	Optionally a list of cohortIds to restrict to

Details

Specify the connectionHandler, the schema and the cohort IDs

Value

Returns a data.frame with the cohort inclusion stats

See Also

Other Cohorts: getCohortAttrition(), getCohortCounts(), getCohortDefinitions(), getCohortInclusionRules(), getCohortInclusionSummary(), getCohortMeta(), getCohortSubsetAttrition(), getCohortSubsetDefinitions(), getSubsetText(), processCohortDefinitionsForQuarto(), processCohorts(), restrictCohortDefinitionsForQuarto()

Examples

conDet <- getExampleConnectionDetails()

connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)

cohortInclsuionsStats <- getCohortInclusionStats(
  connectionHandler = connectionHandler, 
  schema = 'main'
)

OhdsiReportGenerator documentation built on Nov. 14, 2026, 1:09 a.m.