From 179dafd8f8b0fc59ce7e6fe025e0044c0e840f57 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <johannes.ranke@jrwb.de>
Date: Thu, 10 Sep 2026 13:02:58 +0200
Subject: Improve examle code for `one_box`

---
 R/twa.R | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'R/twa.R')

diff --git a/R/twa.R b/R/twa.R
index 8ca490d..06292e8 100644
--- a/R/twa.R
+++ b/R/twa.R
@@ -21,13 +21,22 @@
 #' pred_0 <- one_box(10)
 #' plot(pred_0)
 #'
-#' # Use a fitted mkinfit model
+#' # Use a custom mkin model
 #' require(mkin)
+#' SFO_SFO <- mkinmod(
+#'   parent = mkinsub("SFO", to = "m1"),
+#'   m1 = mkinsub("SFO"))
+#' c_0 = c(parent = 100, m1 = 0)
+#' deg_parms = c(k_parent = 0.15, f_parent_to_m1 = 0.5, k_m1 = 0.01)
+#' pred_sfo_sfo <- one_box(SFO_SFO, odeparms = deg_parms, ini = c_0)
+#' plot(pred_sfo_sfo)
+#'
+#' # Use a fitted mkin model
 #' fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
 #' pred_1 <- one_box(fit)
 #' plot(pred_1)
 #'
-#' # Use a model with more than one observed variable
+#' # Use a fitted model with a metabolite
 #' m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
 #' fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
 #' pred_2 <- one_box(fit_2, ini = "model")
@@ -86,15 +95,6 @@ one_box.character <- function(x, ini = 1, parms, ...,
 #' @param solution_type Will be passed to [mkinpredict]
 #' @importFrom mkin mkinpredict
 #' @export
-#' @examples
-#' library(mkin)
-#' SFO_SFO <- mkinmod(
-#'   parent = mkinsub("SFO", to = "m1"),
-#'   m1 = mkinsub("SFO"))
-#' c_0 = c(parent = 100, m1 = 0)
-#' deg_parms = c(k_parent = 0.15, f_parent_to_m1 = 0.5, k_m1 = 0.01)
-#' sfo_sfo_box <- one_box(SFO_SFO, odeparms = deg_parms, ini = c_0)
-#' head(sfo_sfo_box)
 one_box.mkinmod <- function(x,
   ini = c(1, rep(0, length(x$diffs) - 1)),
   odeparms,
-- 
cgit v1.2.3