From df2e56c3ec7b166a2d329cf41ef58ec268910f44 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <johannes.ranke@jrwb.de>
Date: Thu, 10 Sep 2026 12:42:19 +0200
Subject: Update online docs

---
 docs/reference/pfm_degradation.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'docs/reference/pfm_degradation.md')

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)
+
 ```
-- 
cgit v1.2.3