| cdm_from_environment {CDMConnector} | R Documentation |
Create a CDM object from a pre-defined set of environment variables
Description
This function is intended to be used with the Darwin execution engine. The execution engine
runs OHDSI studies in a pre-defined runtime environment and makes several environment
variables available for connecting to a CDM database. Programmer writing code to run
on the execution engine and simply use cdm <- cdm_from_environment() to create a cdm reference
object to use for their analysis and the database connection and cdm object should be
automatically created. This obviates the need for site specific code for connecting
to the database and creating the cdm reference object.
Usage
cdm_from_environment(write_prefix = "")
Arguments
write_prefix |
(string) An optional prefix to use for all tables written to the CDM. |
Details
The environment variables used by this function and provided by the execution engine are listed below.
DBMS_TYPE: one of "postgresql", "sql server", "redshift", "duckdb", "snowflake".
DATA_SOURCE_NAME: a free text name for the CDM given by the person running the study.
CDM_VERSION: one of "5.3", "5.4".
DBMS_CATALOG: The database catalog. Important primarily for compound schema names used in SQL Server and Snowflake.
DBMS_SERVER: The database server URL.
DBMS_NAME: The database name used for creating the connection.
DBMS_PORT: The database port number.
DBMS_USERNAME: The database username needed to authenticate.
DBMS_PASSWORD: The database password needed to authenticate.
CDM_SCHEMA: The schema name where the OMOP CDM is located in the database.
WRITE_SCHEMA: The shema where the user has write access and tables will be created during study execution.
Value
A cdm_reference object
Examples
## Not run:
library(CDMConnector)
# This will only work in an evironment where the proper variables are present.
cdm <- cdm_from_environment()
# Proceed with analysis using the cdm object.
# Close the database connection when done.
cdm_disconnect(cdm)
## End(Not run)