getCohortInclusionRules: Extract the cohort inclusion rules

View source: R/CohortQueries.R

getCohortInclusionRulesR Documentation

Extract the cohort inclusion rules

Description

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

Usage

getCohortInclusionRules(
  connectionHandler,
  schema,
  cgTablePrefix = "cg_",
  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

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 rules

See Also

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

Examples

conDet <- getExampleConnectionDetails()

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

cohortInclsuionsRules <- getCohortInclusionRules(
  connectionHandler = connectionHandler, 
  schema = 'main'
)


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