summaryrefslogtreecommitdiff
path: root/docs/reference/one_box.md
diff options
context:
space:
mode:
authorJohannes Ranke <johannes.ranke@jrwb.de>2026-09-10 12:42:19 +0200
committerJohannes Ranke <johannes.ranke@jrwb.de>2026-09-10 12:42:19 +0200
commitdf2e56c3ec7b166a2d329cf41ef58ec268910f44 (patch)
tree6026db3112c8f904f8cf6e0f5de120a39a6fdb4b /docs/reference/one_box.md
parenta034219e2edbbf82b3cc586c611a41b625ca8a82 (diff)
Update online docs
Diffstat (limited to 'docs/reference/one_box.md')
-rw-r--r--docs/reference/one_box.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/reference/one_box.md b/docs/reference/one_box.md
index 0c93346..f956b8f 100644
--- a/docs/reference/one_box.md
+++ b/docs/reference/one_box.md
@@ -13,6 +13,17 @@ one_box(x, ini = 1, ..., t_end = 100, res = 0.01)
# S3 method for class 'character'
one_box(x, ini = 1, parms, ..., t_end = 100, res = 0.01)
+# S3 method for class 'mkinmod'
+one_box(
+ x,
+ ini = c(1, rep(0, length(x$diffs) - 1)),
+ odeparms,
+ solution_type = "deSolve",
+ ...,
+ t_end = 100,
+ res = 0.01
+)
+
# S3 method for class 'mkinfit'
one_box(x, ini = "model", ..., t_end = 100, res = 0.01)
```
@@ -53,6 +64,16 @@ one_box(x, ini = "model", ..., t_end = 100, res = 0.01)
A named numeric vector containing the model parameters
+- odeparms:
+
+ Will be passed to
+ [mkinpredict](https://pkgdown.jrwb.de/mkin/reference/mkinpredict.html)
+
+- solution_type:
+
+ Will be passed to
+ [mkinpredict](https://pkgdown.jrwb.de/mkin/reference/mkinpredict.html)
+
## Value
An object of class `one_box`, inheriting from
@@ -80,4 +101,25 @@ 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
```

Contact - Imprint