createCohortSettings: Create cohort settings.

View source: R/createSettings.R

createCohortSettingsR Documentation

Create cohort settings.

Description

Create cohort settings.

Usage

createCohortSettings(
  cohortsToCreate_location = NULL,
  targetCohorts = NULL,
  eventCohorts = NULL,
  loadCohorts = FALSE,
  cohortsFolder = NULL,
  baseUrl = NULL,
  generateCohorts = TRUE,
  includeDescendants = TRUE
)

Arguments

cohortsToCreate_location

Optional: Location of saved cohortsToCreate object.

targetCohorts

Data frame containing the study population of interest (cohortId = "Unique ID number", cohortName = "Descriptive name cohort", optional: atlasId = "Cohort ID ATLAS", optional: conceptSet = "Concept set to use with SQL template").

eventCohorts

Data frame containing the events of interest (cohortId = "Unique ID number", cohortName = "Descriptive name cohort", optional: atlasId = "Cohort ID ATLAS", optional: conceptSet = "Concept set to use with SQL template").

loadCohorts

Setting to retrieve cohort definitions with atlasId from ATLAS WebApi.

cohortsFolder

Location where cohort definitions are stored (SQL/JSON files).

baseUrl

The base URL for the WebApi instance, for example: "http://server.org:80/WebAPI". Note, there is no trailing '/'. If trailing '/' is used, you may receive an error.

generateCohorts

Setting to (re)generate cohortTable in the database.

includeDescendants

Whether to include all descendants of Custom cohorts defined using conceptSet.

Value

Object cohortSettings.


mi-erasmusmc/TreatmentPatterns documentation built on July 1, 2023, 9:20 p.m.