healthcareai (version 2.3.0)

save_models: Save models to disk and load models from disk

Description

Note that model objects contain training data, except columns ignored (patient_id in the example below). Therefore, if there is PHI in the training data, the saved model object must be treated as PHI. save_models issues a message saying as much.

Usage

save_models(x, filename = "models.RDS", sanitize_phi = TRUE)
load_models(filename)

Arguments

x

model_list object

filename

File path to save model to or read model from, e.g. "models/my_models.RDS". Default for save_models is "models.RDS" in the working directory (getwd()). Default for load_models is to open a dialog box from which a file can be selected, in which case a message will issued with code to load the same file without interactivity.

sanitize_phi

Logical. If TRUE (default) training data is removed from the model object before being saved. Removing training data is important when sharing models that were trained with data that contain PHI. If removed, explore will not have data to process.

Value

load_models returns the model_list which can be assigned to any variable name

Examples

# NOT RUN {
m <- machine_learn(pima_diabetes, patient_id, outcome = diabetes)
save_models(m, "diabetes_models.RDS")
# Restart R, move RDS file to another computer, etc.
m2 <- load_models("diabetes_models.RDS")
all.equal(m, m2)
# }