R/util-save_load.R

In BKT: Bayesian Knowledge Tracing Model

#' Save
#'
#' Save a BKT model to a file.
#' This function saves a trained BKT model to a specified file location. The model is stored
#' as an RDS file, which can be loaded back into R using the `load_model()` function.
#'
#' @param model A trained BKT model object to be saved.
#' @param loc Character. The file path where the model will be saved, typically with an `.rds` extension.
#' @return None. The function saves the model to the specified location.
#' @examples
#' \donttest{
#' model <- bkt(seed = 42)
#' fit_model <- fit(model, data_path = "ct.csv")
#' save_model(fit_model, "bkt_model.rds")
#' }
#' @export
save_model <- function(model, loc) {
    saveRDS(object = model, file = loc)
}

#' Load
#'
#' Load a BKT model from a file.
#' This function loads a previously saved BKT model from an RDS file. The model attributes
#' are restored into the provided model object, allowing it to be used for further analysis or predictions.
#'
#' @param model A BKT model object into which the saved model's attributes will be loaded.
#' @param loc Character. The file path from which the model will be loaded, typically an `.rds` file.
#' @return The updated BKT model object with the restored attributes from the saved model.
#' @examples
#' \donttest{
#' model <- bkt(seed = 42)
#' loaded_model <- load_model(model, "bkt_model.rds")
#' }
#' @export
load_model <- function(model, loc) {
    orig_model <- readRDS(loc)

    for (attr in slotNames(orig_model)) {
        slot(model, attr) <- slot(orig_model, attr)
    }

    return(model)
}