execute: Execute the validation study

Description Usage Arguments Details

View source: R/main.R

Description

Execute the validation study

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
execute(
  connectionDetails,
  databaseName,
  cdmDatabaseSchema,
  cohortDatabaseSchema,
  oracleTempSchema,
  cohortTable,
  outputFolder,
  createCohorts = T,
  runValidation = T,
  createImputationData = T,
  causeImputation = T,
  packageResults = T,
  minCellCount = 5,
  sampleSize = NULL
)

Arguments

connectionDetails

An object of type connectionDetails as created using the createConnectionDetails function in the DatabaseConnector package.

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

createImputationData

whether to create table for causeValidation

causeImputation

whether to run the validation function of causePrediction

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

Details

This function will execute the sepcified parts of the study


ted9219/CoDImputationHeart documentation built on Sept. 15, 2020, 11:30 a.m.