createPlpResultTables: Create the results tables to store PatientLevelPrediction...

In OHDSI/PatientLevelPrediction: Develop Clinical Prediction Models Using the Common Data Model

Create the results tables to store PatientLevelPrediction models and results into a database

Description

This function executes a large set of SQL statements to create tables that can store models and results

Usage

createPlpResultTables(
  connectionDetails,
  targetDialect = "postgresql",
  resultSchema,
  deleteTables = TRUE,
  createTables = TRUE,
  tablePrefix = "",
  tempEmulationSchema = getOption("sqlRenderTempEmulationSchema"),
  testFile = NULL
)

Arguments

connectionDetails	The database connection details
targetDialect	The database management system being used
resultSchema	The name of the database schema that the result tables will be created.
deleteTables	If true any existing tables matching the PatientLevelPrediction result tables names will be deleted
createTables	If true the PatientLevelPrediction result tables will be created
tablePrefix	A string that appends to the PatientLevelPrediction result tables
tempEmulationSchema	The temp schema used when the database management system is oracle
testFile	(used for testing) The location of an sql file with the table creation code

Details

This function can be used to create (or delete) PatientLevelPrediction result tables

Value

Returns NULL but creates or deletes the required tables in the specified database schema(s).

Examples

# create a sqlite database with the PatientLevelPrediction result tables
connectionDetails <- DatabaseConnector::createConnectionDetails(
  dbms = "sqlite",
  server = file.path(tempdir(), "test.sqlite"))
createPlpResultTables(connectionDetails = connectionDetails,
                      targetDialect = "sqlite",
                      resultSchema = "main",
                      tablePrefix = "plp_")
# delete the tables
createPlpResultTables(connectionDetails = connectionDetails,
                      targetDialect = "sqlite",
                      resultSchema = "main",
                      deleteTables = TRUE,
                      createTables = FALSE,
                      tablePrefix = "plp_")
# clean up the database file
unlink(file.path(tempdir(), "test.sqlite"))

OHDSI/PatientLevelPrediction documentation built on Feb. 14, 2025, 9:44 a.m.