summaryrefslogtreecommitdiff
path: root/docs/reference/pfm_degradation.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/pfm_degradation.md
parenta034219e2edbbf82b3cc586c611a41b625ca8a82 (diff)
Update online docs
Diffstat (limited to 'docs/reference/pfm_degradation.md')
-rw-r--r--docs/reference/pfm_degradation.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/docs/reference/pfm_degradation.md b/docs/reference/pfm_degradation.md
index fb241ff..7dba450 100644
--- a/docs/reference/pfm_degradation.md
+++ b/docs/reference/pfm_degradation.md
@@ -44,6 +44,12 @@ pfm_degradation(
The output times
+## Value
+
+A data frame containing the output times and the concentrations assuming
+initial concentrations of 1 for the parent and zero for metabolites, if
+any.
+
## Author
Johannes Ranke
@@ -51,7 +57,9 @@ Johannes Ranke
## Examples
``` r
-head(pfm_degradation("SFO", DT50 = 10))
+# Simple example of an SFO decline curve
+sfo_out <- pfm_degradation("SFO", DT50 = 10)
+head(sfo_out)
#> time parent
#> 0 0 1.0000000
#> 1 1 0.9330330
@@ -59,4 +67,23 @@ head(pfm_degradation("SFO", DT50 = 10))
#> 3 3 0.8122524
#> 4 4 0.7578583
#> 5 5 0.7071068
+
+# Fictive example with a metabolite where we first generate an SFO-SFO model
+sfo_sfo <- mkinmod(
+ parent = mkinsub("SFO", to = "metabolite"),
+ metabolite = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+
+sfo_sfo_out <- pfm_degradation(sfo_sfo,
+ parms = c(k_parent = 0.1, f_parent_to_metabolite = 0.5, k_metabolite = 0.02))
+
+plot(
+ sfo_sfo_out[, "time"],
+ sfo_sfo_out[, "parent"], type = "l",
+ xlab = "Time", ylab = "Relative concentration",
+ xlim = c(0, 100))
+lines(
+ sfo_sfo_out[, "time"],
+ sfo_sfo_out[, "metabolite"], lty = 2)
+
```

Contact - Imprint