Learn R Programming

OhdsiReportGenerator (version 2.0.2)

getCohortDefinitions: Extract the cohort definition details

Description

This function extracts all cohort definitions for the targets of interest.

Usage

getCohortDefinitions(
  connectionHandler,
  schema,
  cgTablePrefix = "cg_",
  targetIds = NULL
)

Value

Returns a data.frame with the cohort details

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

targetIds

A vector of integers corresponding to the target cohort IDs

Details

Specify the connectionHandler, the schema and the target cohort IDs

See Also

Other Cohorts: getCohortCounts(), getCohortInclusionRules(), getCohortInclusionStats(), getCohortInclusionSummary(), getCohortMeta(), getCohortSubsetDefinitions(), processCohorts()

Examples

Run this code
conDet <- getExampleConnectionDetails()

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

cohortDef <- getCohortDefinitions(
  connectionHandler = connectionHandler, 
  schema = 'main'
)

Run the code above in your browser using DataLab