aboutsummaryrefslogtreecommitdiff
path: root/man/mkinsub.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2015-10-16 16:31:29 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2015-10-16 16:31:29 +0200
commit08cae49345c048fdbb69befc5a3b3f7966836223 (patch)
treee420c606903015f105d804af89b8165df5aad841 /man/mkinsub.Rd
parent4cc35d77e9ce6fb46f5ba37350a281bf0a82f286 (diff)
Full compound names in models that are shown in the plot
Diffstat (limited to 'man/mkinsub.Rd')
-rw-r--r--man/mkinsub.Rd13
1 files changed, 12 insertions, 1 deletions
diff --git a/man/mkinsub.Rd b/man/mkinsub.Rd
index 9eeffda0..352c4097 100644
--- a/man/mkinsub.Rd
+++ b/man/mkinsub.Rd
@@ -8,7 +8,7 @@
\code{\link{mkinmod}}.
}
\usage{
-mkinsub(submodel, to = NULL, sink = TRUE)
+mkinsub(submodel, to = NULL, sink = TRUE, full_name = NA)
}
\arguments{
\item{submodel}{
@@ -23,6 +23,12 @@ mkinsub(submodel, to = NULL, sink = TRUE)
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}}.
@@ -40,5 +46,10 @@ SFO_SFO <- mkinmod(
SFO_SFO.2 <- mkinmod(
parent = mkinsub("SFO", "m1"),
m1 = mkinsub("SFO"))
+
+# Now supplying full names
+SFO_SFO.2 <- mkinmod(
+ parent = mkinsub("SFO", "m1", full_name = "Test compound"),
+ m1 = mkinsub("SFO", full_name = "Metabolite M1"))
}

Contact - Imprint