createCohortBasedCovariateSettings: Create settings for covariates based on other cohorts

Description

Create settings for covariates based on other cohorts

Usage

createCohortBasedCovariateSettings(
  analysisId,
  covariateCohortDatabaseSchema = NULL,
  covariateCohortTable = NULL,
  covariateCohorts,
  valueType = "binary",
  startDay = -365,
  endDay = 0,
  includedCovariateIds = c(),
  warnOnAnalysisIdOverlap = TRUE
)

Value

An object of type covariateSettings, to be used in other functions.

Arguments

analysisId: A unique identifier for this analysis.
covariateCohortDatabaseSchema: The database schema where the cohorts used to define the covariates can be found. If set to NULL, the database schema will be guessed, for example using the same one as for the main cohorts.
covariateCohortTable: The table where the cohorts used to define the covariates can be found. If set to NULL, the table will be guessed, for example using the same one as for the main cohorts.
covariateCohorts: A data frame with at least two columns: 'cohortId' and 'cohortName'. The cohort ID should correspond to the cohort_definition_id of the cohort to use for creating a covariate.
valueType: Either 'binary' or 'count'. When valueType = 'count', the covariate value will be the number of times the cohort was observed in the window.
startDay: What is the start day (relative to the index date) of the covariate window?
endDay: What is the end day (relative to the index date) of the covariate window?
includedCovariateIds: A list of covariate IDs that should be restricted to.
warnOnAnalysisIdOverlap: Warn if the provided `analysisId` overlaps with any predefined analysis as available in the `createCovariateSettings()` function.

Details

Creates an object specifying covariates to be constructed based on the presence of other cohorts.