summaryrefslogtreecommitdiff
path: root/docs/reference/pfm_degradation.md
blob: 7dba4506ba5a1f73449f3e6dec4d3541cc51e033 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Calculate a time course of relative concentrations based on an mkinmod model

Calculate a time course of relative concentrations based on an mkinmod
model

## Usage

``` r
pfm_degradation(
  model = "SFO",
  DT50 = 1000,
  parms = c(k_parent = log(2)/DT50),
  years = 1,
  step_days = 1,
  times = seq(0, years * 365, by = step_days)
)
```

## Arguments

- model:

  The degradation model to be used. Either a parent only model like
  'SFO' or 'FOMC', or an mkinmod object

- DT50:

  The half-life. This is only used when simple exponential decline is
  calculated (SFO model).

- parms:

  The parameters used for the degradation model

- years:

  For how many years should the degradation be predicted?

- step_days:

  What step size in days should the output have?

- times:

  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

## Examples

``` r
# 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
#> 2    2 0.8705506
#> 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