execute.Rd
Execute the validation study
execute( connectionDetails, databaseName, cdmDatabaseSchema, cohortDatabaseSchema, oracleTempSchema, cohortTable, outputFolder, createCohorts = T, runValidation = T, packageResults = T, minCellCount = 5, sampleSize = NULL, keepPrediction = T, verbosity = "INFO" )
connectionDetails | An object of type |
---|---|
databaseName | A string representing a shareable name of your databasd |
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'. |
cohortDatabaseSchema | Schema name where intermediate data can be stored. You will need to have write priviliges in this schema. 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. |
cohortTable | The name of the table that will be created in the work database schema. This table will hold the exposure and outcome cohorts used in this study. |
outputFolder | Name of local folder to place results; make sure to use forward slashes (/) |
createCohorts | Whether to create the cohorts for the study |
runValidation | Whether to run the valdiation models |
packageResults | Whether to package the results (after removing sensitive details) |
minCellCount | The min count for the result to be included in the package results |
sampleSize | Whether to sample from the target cohort - if desired add the number to sample |
keepPrediction | Whether to save the individual predictions |
verbosity | Log verbosity |
This function will execute the sepcified parts of the study