diff options
Diffstat (limited to 'R/mkinsub.R')
-rw-r--r-- | R/mkinsub.R | 20 |
1 files changed, 1 insertions, 19 deletions
diff --git a/R/mkinsub.R b/R/mkinsub.R index f87c230a..886f712c 100644 --- a/R/mkinsub.R +++ b/R/mkinsub.R @@ -3,6 +3,7 @@ #' This is a convenience function to set up the lists used as arguments for #' \code{\link{mkinmod}}. #' +#' @rdname mkinmod #' @param submodel Character vector of length one to specify the submodel type. #' See \code{\link{mkinmod}} for the list of allowed submodel names. #' @param to Vector of the names of the state variable to which a @@ -14,25 +15,6 @@ #' your R code will not be portable, \emph{i.e.} may produce unintended plot #' results on other operating systems or system configurations. #' @return A list for use with \code{\link{mkinmod}}. -#' @author Johannes Ranke -#' @examples -#' -#' # One parent compound, one metabolite, both single first order. -#' SFO_SFO <- mkinmod( -#' parent = list(type = "SFO", to = "m1"), -#' m1 = list(type = "SFO")) -#' -#' # The same model using mkinsub -#' SFO_SFO.2 <- mkinmod( -#' parent = mkinsub("SFO", "m1"), -#' m1 = mkinsub("SFO")) -#' -#' \dontrun{ -#' # Now supplying full names -#' SFO_SFO.2 <- mkinmod( -#' parent = mkinsub("SFO", "m1", full_name = "Test compound"), -#' m1 = mkinsub("SFO", full_name = "Metabolite M1")) -#' } #' @export mkinsub <- function(submodel, to = NULL, sink = TRUE, full_name = NA) { |