execute: Execute hivTestStudyCharacterization Study

In Sigfried/hivTestStudy: hivTestStudy Phenotype Characerization

Description

Execute hivTestStudyCharacterization Study

Usage

execute(connectionDetails, cdmDatabaseSchema, targetDatabaseSchema,
  oracleTempSchema = cdmDatabaseSchema, tablePrefix = "", outputFolder,
  createCohorts = TRUE)

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.
tablePrefix	The prefix for the study tables, should be same value used in init()
outputFolder	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.

Details

This function executes the hivTestStudy Characterization Study.

Examples

## Not run: 
connectionDetails <- createConnectionDetails(dbms = "postgresql",
                                             user = "joe",
                                             password = "secret",
                                             server = "myserver")

execute(connectionDetails,
        cdmDatabaseSchema = "cdm_data",
        targetDatabaseSchema = "results",
        oracleTempSchema = NULL,
        tablePrefix = "endo_",
        outputFolder = "c:/temp/study_results")

## End(Not run)

Sigfried/hivTestStudy documentation built on May 21, 2019, 6:47 a.m.