runMultiplePlp: Run a list of predictions analyses

View source: R/RunMultiplePlp.R

runMultiplePlpR Documentation

Run a list of predictions analyses

Description

Run a list of predictions analyses

Usage

runMultiplePlp(
  databaseDetails = createDatabaseDetails(),
  modelDesignList = list(createModelDesign(targetId = 1, outcomeId = 2, modelSettings =
    setLassoLogisticRegression()), createModelDesign(targetId = 1, outcomeId = 3,
    modelSettings = setLassoLogisticRegression())),
  onlyFetchData = F,
  cohortDefinitions = NULL,
  logSettings = createLogSettings(verbosity = "DEBUG", timeStamp = T, logName =
    "runPlp Log"),
  saveDirectory = getwd(),
  sqliteLocation = file.path(saveDirectory, "sqlite")
)

Arguments

databaseDetails

The database settings created using createDatabaseDetails()

modelDesignList

A list of model designs created using createModelDesign()

onlyFetchData

Only fetches and saves the data object to the output folder without running the analysis.

cohortDefinitions

A list of cohort definitions for the target and outcome cohorts

logSettings

The setting specifying the logging for the analyses created using createLogSettings()

saveDirectory

Name of the folder where all the outputs will written to.

sqliteLocation

(optional) The location of the sqlite database with the results

Details

This function will run all specified predictions as defined using .

Value

A data frame with the following columns:

⁠analysisId⁠ The unique identifier for a set of analysis choices.
⁠targetId⁠ The ID of the target cohort populations.
⁠outcomeId⁠ The ID of the outcomeId.
⁠dataLocation⁠ The location where the plpData was saved
⁠the settings ids⁠ The ids for all other settings used for model development.

OHDSI/PatientLevelPrediction documentation built on April 27, 2024, 8:11 p.m.