execute: Execute OHDSI Study (FILL IN NAME)

In jmbanda/LearningEffectiveCTP: What the study does (short line)

Description

Execute OHDSI Study (FILL IN NAME)

Usage

execute(dbms, user = NULL, domain = NULL, password = NULL, server,
  port = NULL, cdmSchema, resultsSchema, file = getDefaultStudyFileName(),
  ...)

Arguments

dbms	The type of DBMS running on the server. Valid values are "mysql" for MySQL "oracle" for Oracle "postgresql" for PostgreSQL "redshift" for Amazon Redshift "sql server" for Microsoft SQL Server "pdw" for Microsoft Parallel Data Warehouse (PDW) "netezza" for IBM Netezza
user	The user name used to access the server. If the user is not specified for SQL Server, Windows Integrated Security will be used, which requires the SQL Server JDBC drivers to be installed.
domain	(optional) The Windows domain for SQL Server only.
password	The password for that user
server	The name of the server
port	(optional) The port on the server to connect to
cdmSchema	Schema name where your patient-level data in OMOP CDM format resides
resultsSchema	(Optional) Schema where you'd like the results tables to be created (requires user to have create/write access)
file	(Optional) Name of local file to place results; makre sure to use forward slashes (/)
...	(FILL IN) Additional properties for this specific study.

Details

This function executes OHDSI Study (FILL IN NAME). This is a study of (GIVE SOME DETAILS). Detailed information and protocol are available on the OHDSI Wiki.

Value

Study results are placed in CSV format files in specified local folder and returned as an R object class OhdsiStudy when sufficiently small. The properties of an OhdsiStudy may differ from study to study.

Examples

## Not run: 
# Run study
execute(dbms = "postgresql",
        user = "joebruin",
        password = "supersecret",
        server = "myserver",
        cdmSchema = "cdm_schema",
        resultsSchema = "results_schema")

# Email result file
email(from = "[e-mail]",
      dataDescription = "CDM4 Simulated Data")

## End(Not run)

jmbanda/LearningEffectiveCTP documentation built on May 19, 2019, 1:51 p.m.