PatientLevelPrediction (version 6.4.1)

createModelDesign: Specify settings for developing a single model

Description

Specify settings for developing a single model

Usage

createModelDesign(
  targetId = NULL,
  outcomeId = NULL,
  restrictPlpDataSettings = createRestrictPlpDataSettings(),
  populationSettings = createStudyPopulationSettings(),
  covariateSettings = FeatureExtraction::createDefaultCovariateSettings(),
  featureEngineeringSettings = NULL,
  sampleSettings = NULL,
  preprocessSettings = NULL,
  modelSettings = NULL,
  splitSettings = createDefaultSplitSetting(),
  runCovariateSummary = TRUE
)

Value

A list with analysis settings used to develop a single prediction model

Arguments

targetId

The id of the target cohort that will be used for data extraction (e.g., the ATLAS id)

outcomeId

The id of the outcome that will be used for data extraction (e.g., the ATLAS id)

restrictPlpDataSettings

The settings specifying the extra restriction settings when extracting the data created using createRestrictPlpDataSettings().

populationSettings

The population settings specified by createStudyPopulationSettings()

covariateSettings

The covariate settings, this can be a list or a single 'covariateSetting' object.

featureEngineeringSettings

Either NULL or an object of class featureEngineeringSettings specifying any feature engineering used during model development

sampleSettings

Either NULL or an object of class sampleSettings with the over/under sampling settings used for model development

preprocessSettings

Either NULL or an object of class preprocessSettings created using createPreprocessingSettings()

modelSettings

The model settings such as setLassoLogisticRegression()

splitSettings

The train/validation/test splitting used by all analyses created using createDefaultSplitSetting()

runCovariateSummary

Whether to run the covariateSummary

Details

This specifies a single analysis for developing as single model

Examples

# L1 logistic regression model to predict the outcomeId 2 using the targetId 2
# with with default population, restrictPlp, split, and covariate settings
createModelDesign(
  targetId = 1,
  outcomeId = 2,
  modelSettings = setLassoLogisticRegression(seed=42),
  populationSettings = createStudyPopulationSettings(),
  restrictPlpDataSettings = createRestrictPlpDataSettings(),
  covariateSettings = FeatureExtraction::createDefaultCovariateSettings(),
  splitSettings = createDefaultSplitSetting(splitSeed = 42),
  runCovariateSummary = TRUE
)