R/makeModel.R

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

#' make Model
#'
#' @description
#' Make a light weight model object that can be used by `transition()`, `TransitionClassification`, `TransitionRegression`.
#'
#' @param model a model object. See `SupportedTransitionModels()`.
#' @param preprocessing_fn a preprocessing function.
#' @param ... dots.
#'
#' @return a `Model` object.
#' @export
"makeModel" <- function(model, ...) {
  UseMethod("makeModel")
}

#' @rdname makeModel
#' @export
makeModel.train <- function(model, preprocessing_fn = NULL, ...) {
  compatible_methods <- c("glm")

  if (!checkmate::test_subset(x = model$method, choices = compatible_methods, empty.ok = FALSE)) {
    stop(
      "ModelCaretTrain only works with: ", paste(compatible_methods, collapse = ", "),
      ".", " Consider using `Model` instead if the given model is not currently supported."
    )
  }

  if (model$method == "glm") {
    return(ModelBinaryChoice$new(
      params = model$finalModel$coefficients,
      formula = model$terms,
      preprocessing_fn = preprocessing_fn
    ))
  }

  stop("something went wrong.")
}

#' @rdname makeModel
makeModel.WrappedModel <- function(model, preprocessing_fn = NULL, ...) {
  stop("Not implemented yet.")
}

#' @rdname makeModel
#' @export
makeModel.mlogit <- function(model, preprocessing_fn = NULL, ...) {
  ModelMultinomialLogit$new(
    params = model[["coefficients"]],
    formula = model[["formula"]],
    preprocessing_fn = preprocessing_fn
  )
}