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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Calculate a time course of relative concentrations based on an mkinmod model — pfm_degradation • pfm</title><!-- mathjax math --><script src="https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-mml-chtml.js" integrity="sha256-MASABpB4tYktI2Oitl4t+78w/lyA+D7b/s9GEP0JOGI=" crossorigin="anonymous"></script><script>
window.MathJax = {
chtml: {
fontURL: "https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2"
}
};
</script><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Calculate a time course of relative concentrations based on an mkinmod model — pfm_degradation"><meta name="description" content="Calculate a time course of relative concentrations based on an mkinmod model"><meta property="og:description" content="Calculate a time course of relative concentrations based on an mkinmod model"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="../index.html">pfm</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.5</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/pfm/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Calculate a time course of relative concentrations based on an mkinmod model</h1>
<small class="dont-index">Source: <a href="https://github.com/jranke/pfm/blob/HEAD/R/pfm_degradation.R" class="external-link"><code>R/pfm_degradation.R</code></a></small>
<div class="d-none name"><code>pfm_degradation.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Calculate a time course of relative concentrations based on an mkinmod model</p>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">pfm_degradation</span><span class="op">(</span></span>
<span> model <span class="op">=</span> <span class="st">"SFO"</span>,</span>
<span> DT50 <span class="op">=</span> <span class="fl">1000</span>,</span>
<span> parms <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>k_parent <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Log.html" class="external-link">log</a></span><span class="op">(</span><span class="fl">2</span><span class="op">)</span><span class="op">/</span><span class="va">DT50</span><span class="op">)</span>,</span>
<span> years <span class="op">=</span> <span class="fl">1</span>,</span>
<span> step_days <span class="op">=</span> <span class="fl">1</span>,</span>
<span> times <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq</a></span><span class="op">(</span><span class="fl">0</span>, <span class="va">years</span> <span class="op">*</span> <span class="fl">365</span>, by <span class="op">=</span> <span class="va">step_days</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt id="arg-model">model<a class="anchor" aria-label="anchor" href="#arg-model"></a></dt>
<dd><p>The degradation model to be used. Either a parent only model like
'SFO' or 'FOMC', or an mkinmod object</p></dd>
<dt id="arg-dt-">DT50<a class="anchor" aria-label="anchor" href="#arg-dt-"></a></dt>
<dd><p>The half-life. This is only used when simple exponential decline
is calculated (SFO model).</p></dd>
<dt id="arg-parms">parms<a class="anchor" aria-label="anchor" href="#arg-parms"></a></dt>
<dd><p>The parameters used for the degradation model</p></dd>
<dt id="arg-years">years<a class="anchor" aria-label="anchor" href="#arg-years"></a></dt>
<dd><p>For how many years should the degradation be predicted?</p></dd>
<dt id="arg-step-days">step_days<a class="anchor" aria-label="anchor" href="#arg-step-days"></a></dt>
<dd><p>What step size in days should the output have?</p></dd>
<dt id="arg-times">times<a class="anchor" aria-label="anchor" href="#arg-times"></a></dt>
<dd><p>The output times</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A data frame containing the output times and the concentrations
assuming initial concentrations of 1 for the parent and zero for
metabolites, if any.</p>
</div>
<div class="section level2">
<h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
<p>Johannes Ranke</p>
</div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Simple example of an SFO decline curve</span></span></span>
<span class="r-in"><span><span class="va">sfo_out</span> <span class="op"><-</span> <span class="fu">pfm_degradation</span><span class="op">(</span><span class="st">"SFO"</span>, DT50 <span class="op">=</span> <span class="fl">10</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">sfo_out</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> time parent</span>
<span class="r-out co"><span class="r-pr">#></span> 0 0 1.0000000</span>
<span class="r-out co"><span class="r-pr">#></span> 1 1 0.9330330</span>
<span class="r-out co"><span class="r-pr">#></span> 2 2 0.8705506</span>
<span class="r-out co"><span class="r-pr">#></span> 3 3 0.8122524</span>
<span class="r-out co"><span class="r-pr">#></span> 4 4 0.7578583</span>
<span class="r-out co"><span class="r-pr">#></span> 5 5 0.7071068</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Fictive example with a metabolite where we first generate an SFO-SFO model</span></span></span>
<span class="r-in"><span><span class="va">sfo_sfo</span> <span class="op"><-</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">mkinmod</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> parent <span class="op">=</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span>, to <span class="op">=</span> <span class="st">"metabolite"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> metabolite <span class="op">=</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#></span> Temporary DLL for differentials generated and loaded</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">sfo_sfo_out</span> <span class="op"><-</span> <span class="fu">pfm_degradation</span><span class="op">(</span><span class="va">sfo_sfo</span>,</span></span>
<span class="r-in"><span> parms <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>k_parent <span class="op">=</span> <span class="fl">0.1</span>, f_parent_to_metabolite <span class="op">=</span> <span class="fl">0.5</span>, k_metabolite <span class="op">=</span> <span class="fl">0.02</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"time"</span><span class="op">]</span>,</span></span>
<span class="r-in"><span> <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"parent"</span><span class="op">]</span>, type <span class="op">=</span> <span class="st">"l"</span>,</span></span>
<span class="r-in"><span> xlab <span class="op">=</span> <span class="st">"Time"</span>, ylab <span class="op">=</span> <span class="st">"Relative concentration"</span>,</span></span>
<span class="r-in"><span> xlim <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">100</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/lines.html" class="external-link">lines</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"time"</span><span class="op">]</span>,</span></span>
<span class="r-in"><span> <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"metabolite"</span><span class="op">]</span>, lty <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="pfm_degradation-1.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p>Developed by Johannes Ranke.</p>
</div>
<div class="pkgdown-footer-right">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>
</div>
</footer></div>
</body></html>
|
