diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2020-11-19 15:41:24 +0100 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2020-11-19 15:41:24 +0100 |
commit | db9ae6a0c9cecb92048fde6f06af1da183c09b5f (patch) | |
tree | f0ea97545549c71bd7aa3d13afed422fd402f0e6 /man/mkinsub.Rd | |
parent | 6441a9f35d66f2c4d38c0036f99cd8f509d76f3b (diff) |
Depend on parallel, doc improvements
By depending on parallel instead of importing it, functions to set up
and stop a cluster are always available when mkin is loaded.
The use of multicore processing in mmkin on Windows is now documented in
the help file, which brings mkin closer to a version 1.0 #9.
Diffstat (limited to 'man/mkinsub.Rd')
-rw-r--r-- | man/mkinsub.Rd | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/man/mkinsub.Rd b/man/mkinsub.Rd deleted file mode 100644 index 81615a00..00000000 --- a/man/mkinsub.Rd +++ /dev/null @@ -1,52 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/mkinsub.R -\name{mkinsub} -\alias{mkinsub} -\title{Function to set up a kinetic submodel for one state variable} -\usage{ -mkinsub(submodel, to = NULL, sink = TRUE, full_name = NA) -} -\arguments{ -\item{submodel}{Character vector of length one to specify the submodel type. -See \code{\link{mkinmod}} for the list of allowed submodel names.} - -\item{to}{Vector of the names of the state variable to which a -transformation shall be included in the model.} - -\item{sink}{Should a pathway to sink be included in the model in addition to -the pathways to other state variables?} - -\item{full_name}{An optional name to be used e.g. for plotting fits -performed with the model. You can use non-ASCII characters here, but then -your R code will not be portable, \emph{i.e.} may produce unintended plot -results on other operating systems or system configurations.} -} -\value{ -A list for use with \code{\link{mkinmod}}. -} -\description{ -This is a convenience function to set up the lists used as arguments for -\code{\link{mkinmod}}. -} -\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")) - } -} -\author{ -Johannes Ranke -} |