createGeneralCharacterization: Execute the Study

In ohdsi-studies/VaccineEffectivenessEvaluation: Evaluating Use of Methods for Vaccine Effectiveness

Description

Execute the Study

Usage

createGeneralCharacterization(
  connectionDetails,
  cdmDatabaseSchema,
  oracleTempSchema = NULL,
  exportFolder,
  databaseId,
  cdmVersion = "5"
)

Arguments

connectionDetails	An object of type connectionDetails as created using the createConnectionDetails function in the DatabaseConnector package.
cdmDatabaseSchema	Schema name where your patient-level data in OMOP CDM format resides. Note that for SQL Server, this should include both the database and schema name, for example 'cdm_data.dbo'.
oracleTempSchema	Should be used in Oracle to specify a schema where the user has write priviliges for storing temporary tables.
exportFolder	Name of local folder to place results; make sure to use forward slashes (/). Do not use a folder on a network drive since this greatly impacts performance.
databaseId	A short string for identifying the database (e.g. 'Synpuf').
cdmVersion	Version of the Common Data Model used. Currently only version 5 is supported.

Details

This function executes the Study.

The createCohorts, synthesizePositiveControls, runAnalyses, and runDiagnostics arguments are intended to be used to run parts of the full study at a time, but none of the parts are considerd to be optional.

ohdsi-studies/VaccineEffectivenessEvaluation documentation built on March 19, 2021, 7:59 p.m.