jranke / mkin
1
#' Function to set up a kinetic submodel for one state variable
2
#' 
3
#' This is a convenience function to set up the lists used as arguments for
4
#' \code{\link{mkinmod}}.
5
#' 
6
#' @rdname mkinmod
7
#' @param submodel Character vector of length one to specify the submodel type.
8
#'   See \code{\link{mkinmod}} for the list of allowed submodel names.
9
#' @param to Vector of the names of the state variable to which a
10
#'   transformation shall be included in the model.
11
#' @param sink Should a pathway to sink be included in the model in addition to
12
#'   the pathways to other state variables?
13
#' @param full_name An optional name to be used e.g. for plotting fits
14
#'   performed with the model.  You can use non-ASCII characters here, but then
15
#'   your R code will not be portable, \emph{i.e.} may produce unintended plot
16
#'   results on other operating systems or system configurations.
17
#' @return A list for use with \code{\link{mkinmod}}.
18
#' @export
19
mkinsub <- function(submodel, to = NULL, sink = TRUE, full_name = NA)
20
{
21 1
  return(list(type = submodel, to = to, sink = sink, full_name = full_name))
22
}

Read our documentation on viewing source code .

Loading