From 179dafd8f8b0fc59ce7e6fe025e0044c0e840f57 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 10 Sep 2026 13:02:58 +0200 Subject: Improve examle code for `one_box` --- R/twa.R | 22 ++++++++++---------- docs/reference/one_box-2.png | Bin 33063 -> 44992 bytes docs/reference/one_box-3.png | Bin 45677 -> 33063 bytes docs/reference/one_box-4.png | Bin 0 -> 45677 bytes docs/reference/one_box.html | 39 ++++++++++++++--------------------- docs/reference/one_box.md | 36 ++++++++++++-------------------- docs/reference/one_box.mkinmod.html | 8 +++++++ docs/reference/pfm_degradation-1.png | Bin 0 -> 54592 bytes docs/search.json | 2 +- man/one_box.Rd | 21 ++++++++++--------- 10 files changed, 59 insertions(+), 69 deletions(-) create mode 100644 docs/reference/one_box-4.png create mode 100644 docs/reference/one_box.mkinmod.html create mode 100644 docs/reference/pfm_degradation-1.png 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, diff --git a/docs/reference/one_box-2.png b/docs/reference/one_box-2.png index 6a4d0de..2883ca7 100644 Binary files a/docs/reference/one_box-2.png and b/docs/reference/one_box-2.png differ diff --git a/docs/reference/one_box-3.png b/docs/reference/one_box-3.png index d659e3a..6a4d0de 100644 Binary files a/docs/reference/one_box-3.png and b/docs/reference/one_box-3.png differ diff --git a/docs/reference/one_box-4.png b/docs/reference/one_box-4.png new file mode 100644 index 0000000..d659e3a Binary files /dev/null and b/docs/reference/one_box-4.png differ diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index 3410ac4..8866fcf 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -124,41 +124,32 @@ all observed variables.

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")) +#> Temporary DLL for differentials generated and loaded +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")) #> Temporary DLL for differentials generated and loaded fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE) #> Warning: Observations with value of zero were removed from the data pred_2 <- one_box(fit_2, ini = "model") plot(pred_2) - -library(mkin) -SFO_SFO <- mkinmod( - parent = mkinsub("SFO", to = "m1"), - m1 = mkinsub("SFO")) -#> Temporary DLL for differentials generated and loaded -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) -#> Time Series: -#> Start = c(0, 1) -#> End = c(0, 6) -#> Frequency = 100 -#> parent m1 -#> 0.00 100.00000 0.00000000 -#> 0.01 99.85011 0.07494003 -#> 0.02 99.70045 0.14976024 -#> 0.03 99.55101 0.22446081 -#> 0.04 99.40180 0.29904192 -#> 0.05 99.25281 0.37350376 +