Full compound names in models that are shown in the plot

2 files changed, 14 insertions, 2 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"))
 }
 
diff --git a/man/plot.mkinfit.Rd b/man/plot.mkinfit.Rd
index f26aac4c..494dc38d 100644
--- a/man/plot.mkinfit.Rd
+++ b/man/plot.mkinfit.Rd
@@ -82,7 +82,8 @@
 \examples{
 # One parent compound, one metabolite, both single first order, path from
 # parent to sink included
-SFO_SFO <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+SFO_SFO <- mkinmod(parent = mkinsub("SFO", "m1", full = "Parent"),
+                   m1 = mkinsub("SFO", full = "Metabolite M1" ))
 fit <- mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)
 plot(fit)
 }