/
to_cpz.html
254 lines (204 loc) · 11.2 KB
/
to_cpz.html
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Calculates chlorpromazine-equivalent doses — to_cpz • chlorpromazineR</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Calculates chlorpromazine-equivalent doses — to_cpz" />
<meta property="og:description" content="Given a data.frame containing doses of antipsychotics to_cpz() converts the
doses into the equivalent chlorpromazine (CPZ) doses, using the conversion
factors specified in the key." />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">chlorpromazineR</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.2.9999</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/exampletable.html">Examples produced by chlorpromazineR</a>
</li>
<li>
<a href="../articles/walkthrough.html">Using chlorpromazineR to calculate chlorpromazine-equivalent doses</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/ropensci/chlorpromazineR/">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Calculates chlorpromazine-equivalent doses</h1>
<small class="dont-index">Source: <a href='https://github.com/ropensci/chlorpromazineR/blob/master/R/convert.R'><code>R/convert.R</code></a></small>
<div class="hidden name"><code>to_cpz.Rd</code></div>
</div>
<div class="ref-description">
<p>Given a data.frame containing doses of antipsychotics to_cpz() converts the
doses into the equivalent chlorpromazine (CPZ) doses, using the conversion
factors specified in the key.</p>
</div>
<pre class="usage"><span class='fu'>to_cpz</span><span class='op'>(</span>
<span class='va'>input_data</span>,
<span class='va'>ap_label</span>,
<span class='va'>dose_label</span>,
route <span class='op'>=</span> <span class='st'>"oral"</span>,
key <span class='op'>=</span> <span class='fu'>chlorpromazineR</span><span class='fu'>::</span><span class='va'><a href='gardner2010.html'>gardner2010</a></span>,
eq_label <span class='op'>=</span> <span class='st'>"cpz_eq"</span>,
factor_label <span class='op'>=</span> <span class='st'>"cpz_conv_factor"</span>,
route_label <span class='op'>=</span> <span class='cn'>NULL</span>,
q_label <span class='op'>=</span> <span class='cn'>NULL</span>
<span class='op'>)</span></pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>input_data</th>
<td><p>data.frame with antipsychotic name and dose data</p></td>
</tr>
<tr>
<th>ap_label</th>
<td><p>column in x that stores antipsychotic name</p></td>
</tr>
<tr>
<th>dose_label</th>
<td><p>column in x that stores dose</p></td>
</tr>
<tr>
<th>route</th>
<td><p>options include "oral", "sai", "lai" or "mixed"</p></td>
</tr>
<tr>
<th>key</th>
<td><p>source of the conversion factors--defaults to Gardner et al. 2010</p></td>
</tr>
<tr>
<th>eq_label</th>
<td><p>the name of the column to be created, to save the
calculated CPZ-equivalent dose</p></td>
</tr>
<tr>
<th>factor_label</th>
<td><p>the name of the column to be created to store the
conversion factors</p></td>
</tr>
<tr>
<th>route_label</th>
<td><p>if "mixed" route is specified, provide the column that
stores the route information</p></td>
</tr>
<tr>
<th>q_label</th>
<td><p>if long-acting injectable doses are included, provide the
column that stores the injection frequency (days), or only if the doses have
already been divided, set q_label = 1.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>data.frame with new variables storing conversion factor and
CPZ-equivalent doses</p>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>The default key is gardner2010 which has data for both oral and long-acting
antipsychotic medications. See help(gardner2010) for the source reference.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p>Other conversion functions:
<code><a href='to_ap.html'>to_ap</a>()</code></p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='va'>participant_ID</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='st'>"P01"</span>, <span class='st'>"P02"</span>, <span class='st'>"P03"</span>, <span class='st'>"P04"</span><span class='op'>)</span>
<span class='va'>age</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='fl'>42</span>, <span class='fl'>29</span>, <span class='fl'>30</span>, <span class='fl'>60</span><span class='op'>)</span>
<span class='va'>antipsychotic</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='st'>"olanzapine"</span>, <span class='st'>"olanzapine"</span>, <span class='st'>"quetiapine"</span>, <span class='st'>"ziprasidone"</span><span class='op'>)</span>
<span class='va'>dose</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='fl'>10</span>, <span class='fl'>12.5</span>, <span class='fl'>300</span>, <span class='fl'>60</span><span class='op'>)</span>
<span class='va'>example_oral</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span><span class='op'>(</span><span class='va'>participant_ID</span>, <span class='va'>age</span>, <span class='va'>antipsychotic</span>, <span class='va'>dose</span>,
stringsAsFactors <span class='op'>=</span> <span class='cn'>FALSE</span><span class='op'>)</span>
<span class='fu'>to_cpz</span><span class='op'>(</span><span class='va'>example_oral</span>, ap_label <span class='op'>=</span> <span class='st'>"antipsychotic"</span>, dose_label <span class='op'>=</span> <span class='st'>"dose"</span>,
route <span class='op'>=</span> <span class='st'>"oral"</span><span class='op'>)</span>
</div><div class='output co'>#> participant_ID age antipsychotic dose cpz_conv_factor cpz_eq
#> 1 P01 42 olanzapine 10.0 30.00 300
#> 2 P02 29 olanzapine 12.5 30.00 375
#> 3 P03 30 quetiapine 300.0 0.80 240
#> 4 P04 60 ziprasidone 60.0 3.75 225</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top">
<h2 data-toc-skip>Contents</h2>
</nav>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Eric Brown, Parita Shah, Julia Kim.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>
</footer>
</div>
</body>
</html>