R/mcode.R

In mrgsolve: Simulate from ODE-Based Models

# Copyright (C) 2013 - 2024  Metrum Research Group
#
# This file is part of mrgsolve.
#
# mrgsolve is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# mrgsolve is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with mrgsolve.  If not, see <http://www.gnu.org/licenses/>.


#' Write, compile, and load model code
#'
#' This is a convenience function that ultimately calls [mread()].
#' Model code is written to a file and read back in using [mread()].
#'
#' @param model model name.
#' @param project project directory for the model.
#' @param code character string specifying a `mrgsolve` model.
#' @param ... passed to [mread()]; see that help topic for other arguments 
#' that can be set.
#' 
#' @details
#' Note that the arguments are in slightly different order than 
#' [mread()].  The default `project` is [tempdir()].
#' 
#' See the [mread()] help topic for discussion about caching
#' compilation results with [mcode_cache()].  
#'
#' @examples
#' \dontrun{ 
#' code <- '
#' $CMT DEPOT CENT
#' $PKMODEL ncmt=1, depot=TRUE
#' $MAIN
#' double CL = 1;
#' double V = 20;
#' double KA = 1;
#' '
#'
#' mod <- mcode("example", code, compile = FALSE)
#' }
#' 
#' @seealso [mread()], [mread_cache()]
#' 
#' @md
#' @export
mcode <- function(
  model, code, project = getOption("mrgsolve.project", tempdir()), ...) {
  mread(model=model, project=project, code=code, ...)
}

#' @rdname mcode
#' @export
mcode_cache <- function(
  model, code, project = getOption("mrgsolve.project", tempdir()),  ...) {
  mread_cache(model, project, code = code, ...)
}