Skip to contents

Extract the cohort definition details

Source: R/CohortQueries.R
getCohortDefinitions.Rd

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

Usage

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

targetIds

A vector of integers corresponding to the target cohort IDs

Value

Returns a data.frame with the cohort details

Details

Specify the connectionHandler, the schema and the target cohort IDs

See also

Other Cohorts: getCohortSubsetDefinitions(), processCohorts()

Examples

conDet <- getExampleConnectionDetails()

connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)
#> Connecting using SQLite driver

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