/
get_data_dict.html
315 lines (258 loc) · 13.9 KB
/
get_data_dict.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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<!-- 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>Get the WHO Data Dictionary for TB Data — get_data_dict • getTBinR</title>
<!-- favicons -->
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png" />
<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png" />
<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png" />
<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png" />
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/lumen/bootstrap.min.css" rel="stylesheet" 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>
<!-- docsearch -->
<script src="../docsearch.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.3/docsearch.min.css" integrity="sha256-QOSRU/ra9ActyXkIBbiIB144aDBdtvXBcNc3OTNuX/Q=" crossorigin="anonymous" />
<link href="../docsearch.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.min.js" integrity="sha256-4HLtjeVgH0eIB3aZ9mLYF6E8oU5chNdjU6p6rrXpl9U=" crossorigin="anonymous"></script>
<meta property="og:title" content="Get the WHO Data Dictionary for TB Data — get_data_dict" />
<meta property="og:description" content="Get the data dictionary for TB burden data from the WHO, see
here for details. This function will first attempt
to load the data from the temporary directory (tempdir). If that fails, and download_data = TRUE, it
will instead download the data." />
<meta property="og:image" content="samabbott.co.uk/getTBinR/logo.png" />
<!-- 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-inverse 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">getTBinR</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.1</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">Home</a>
</li>
<li>
<a href="../articles/intro.html">Getting Started</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Case Studies
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/case_study_global_trends.html">Exploring Global Trends in Tuberculosis Incidence Rates</a>
</li>
<li>
<a href="../articles/case_fatality_rate.html">Exploring Estimates of the Tuberculosis Case Fatality Ratio</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Dashboards
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="http://www.seabbs.co.uk/shiny/ExploreGlobalTB/">Explore Global Tuberculosis</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
News
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="https://www.samabbott.co.uk/tags/who/">Blog posts</a>
</li>
<li class="divider"></li>
<li>
<a href="../news/index.html">Change log</a>
</li>
</ul>
</li>
<li>
<a href="../reference/index.html">
<span class="fa fa-file-code-o"></span>
Functions
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/seabbs/getTBinR/">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right hidden-xs hidden-sm" role="search">
<div class="form-group">
<input type="search" class="form-control" name="search-input" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off">
</div>
</form>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Get the WHO Data Dictionary for TB Data</h1>
<small class="dont-index">Source: <a href='https://github.com/seabbs/getTBinR/blob/master/R/get_data_dict.R'><code>R/get_data_dict.R</code></a></small>
<div class="hidden name"><code>get_data_dict.Rd</code></div>
</div>
<div class="ref-description">
<p>Get the data dictionary for TB burden data from the WHO, see
<a href='http://www.who.int/tb/country/data/download/en/'>here</a> for details. This function will first attempt
to load the data from the temporary directory (<code><a href='https://rdrr.io/r/base/tempfile.html'>tempdir</a></code>). If that fails, and <code>download_data = TRUE</code>, it
will instead download the data.</p>
</div>
<pre class="usage"><span class='fu'>get_data_dict</span>(
<span class='kw'>url</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='kw'>download_data</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
<span class='kw'>save</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
<span class='kw'>dict_save_name</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='kw'>return</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
<span class='kw'>verbose</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
<span class='kw'>use_utils</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
<span class='kw'>retry_download</span> <span class='kw'>=</span> <span class='fl'>TRUE</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>url</th>
<td><p>Character string, indicating the url of the data
dictionary. This argument is depreciated and will be removed from future releases.</p></td>
</tr>
<tr>
<th>download_data</th>
<td><p>Logical, defaults to <code>TRUE</code>. If not found locally should the data be
downloaded from the specified URL?</p></td>
</tr>
<tr>
<th>save</th>
<td><p>Logical, should the data be saved for reuse during the current R session. Defaults to
<code>TRUE</code>. If <code>TRUE</code> then the data is saved to the temporary directory specified by <code><a href='https://rdrr.io/r/base/tempfile.html'>tempdir</a></code>.</p></td>
</tr>
<tr>
<th>dict_save_name</th>
<td><p>Character string, name to save dictionary under. This argument is depreciated
and will be removed from future releases. Dataset naming is now handled internally.</p></td>
</tr>
<tr>
<th>return</th>
<td><p>Logical, should the data dictionary be returned as a dataframe.
Defaults to <code>TRUE</code>.</p></td>
</tr>
<tr>
<th>verbose</th>
<td><p>Logical, defaults to <code>FALSE</code>. Should additional status and progress messages
be displayed.</p></td>
</tr>
<tr>
<th>use_utils</th>
<td><p>Logical, defaults to <code>FALSE</code>. Used for testing alternative
data download function. When <code>TRUE</code> data is downloaded using <code>read.csv</code>.</p></td>
</tr>
<tr>
<th>retry_download</th>
<td><p>Logical defaults to <code>TRUE</code>. When <code>TRUE</code>, if downloading
fails, the function will try repeatedly to download the data within 3 seconds, up
to 3 times.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>The WHO TB data dictionary as a tibble with 4 variables:
variable_name, dataset, code_list, definition.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p>get_data search_data_dict</p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'>
<span class='no'>dict</span> <span class='kw'><-</span> <span class='fu'>get_data_dict</span>()
<span class='fu'><a href='https://rdrr.io/r/utils/head.html'>head</a></span>(<span class='no'>dict</span>)</div><div class='output co'>#> <span style='color: #555555;'># A tibble: 6 x 4</span><span>
#> variable_name dataset code_list definition
#> </span><span style='color: #555555;font-style: italic;'><chr></span><span> </span><span style='color: #555555;font-style: italic;'><chr></span><span> </span><span style='color: #555555;font-style: italic;'><chr></span><span> </span><span style='color: #555555;font-style: italic;'><chr></span><span>
#> </span><span style='color: #555555;'>1</span><span> budget_cpp_dstb Budget </span><span style='color: #555555;'>""</span><span> Average cost of drugs budgeted per patient …
#> </span><span style='color: #555555;'>2</span><span> budget_cpp_mdr Budget </span><span style='color: #555555;'>""</span><span> Average cost of drugs budgeted per patient …
#> </span><span style='color: #555555;'>3</span><span> budget_cpp_xdr Budget </span><span style='color: #555555;'>""</span><span> Average cost of drugs budgeted per patient …
#> </span><span style='color: #555555;'>4</span><span> budget_fld Budget </span><span style='color: #555555;'>""</span><span> Budget required for drugs to treat drug-sus…
#> </span><span style='color: #555555;'>5</span><span> budget_lab Budget </span><span style='color: #555555;'>""</span><span> Budget required for laboratory infrastructu…
#> </span><span style='color: #555555;'>6</span><span> budget_mdrmgt Budget </span><span style='color: #555555;'>""</span><span> Budget required for programme costs to trea…</div></span></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 Sam Abbott.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.9000.</p>
</div>
</footer>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.1/docsearch.min.js" integrity="sha256-GKvGqXDznoRYHCwKXGnuchvKSwmx9SRMrZOTh2g4Sb0=" crossorigin="anonymous"></script>
<script>
docsearch({
apiKey: '6c737a6c632ea7eab75c912a6b07b5f1',
indexName: 'gettbinr',
inputSelector: 'input#search-input.form-control',
transformData: function(hits) {
return hits.map(function (hit) {
hit.url = updateHitURL(hit);
return hit;
});
}
});
</script>
</body>
</html>