R/createModel.R

In MCSimMod: Working with 'MCSim' Models

#' Function to create an MCSimMod Model object
#'
#' This function creates a `Model` object using an MCSim model specification
#' file or an MCSim model specification string.
#'
#' @examples
#' \dontrun{
#' # Simple model
#' mod <- createModel("path/to/model")
#'
#' # Load/compile the model
#' mod$loadModel()
#'
#' # Update parameters (P1 and P2)
#' mod$updateParms(c(P1 = 3, P2 = 1))
#'
#' # Define times for ODE simulation
#' times <- seq(from = 0, to = 24, by = 0.1)
#'
#' # Run the simulation
#' out <- mod$runModel(times)
#' }
#'
#' @param mName Name of an MCSim model specification file, excluding the file name extension `.model`.
#' @param mString A character string containing MCSim model specification text.
#' @param writeTemp Boolean specifying whether to write model files to a temporary directory. If value is TRUE (the default), model files will be Written to a temporary directory; if value is FALSE, model files will be Written to the same directory that contains the model specification file.
#' @returns Model object.
#' @export
createModel <- function(mName = character(0), mString = character(0), writeTemp = TRUE) {
  return(Model(mName = mName, mString = mString, writeTemp = writeTemp))
}