aboutsummaryrefslogtreecommitdiff
path: root/man/mkinsub.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-10-25 00:37:42 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:03:54 +0200
commit0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (patch)
tree1bf0ffeb710b3438fee224d0a657606b4c36b495 /man/mkinsub.Rd
parent053bf27d3f265c7a7378e2df3e00cf891e0d1bb2 (diff)
Use roxygen for functions and methods
Diffstat (limited to 'man/mkinsub.Rd')
-rw-r--r--man/mkinsub.Rd54
1 files changed, 25 insertions, 29 deletions
diff --git a/man/mkinsub.Rd b/man/mkinsub.Rd
index 84e38e21..6522a37e 100644
--- a/man/mkinsub.Rd
+++ b/man/mkinsub.Rd
@@ -1,42 +1,35 @@
+% 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
-}
-\description{
- This is a convenience function to set up the lists used as arguments for
- \code{\link{mkinmod}}.
-}
+\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.
- }
+\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}}.
+A list for use with \code{\link{mkinmod}}.
}
-\author{
- Johannes Ranke
+\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"),
@@ -51,5 +44,8 @@ SFO_SFO.2 <- mkinmod(
SFO_SFO.2 <- mkinmod(
parent = mkinsub("SFO", "m1", full_name = "Test compound"),
m1 = mkinsub("SFO", full_name = "Metabolite M1"))
-}
+}
+\author{
+Johannes Ranke
+}

Contact - Imprint