/
CountryDataClass.html
212 lines (166 loc) · 16.7 KB
/
CountryDataClass.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
<!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"><meta name="description" content="Acts as parent class for national data classes, allowing them
to access general methods defined in DataClass() but with additional"><!-- Inform modern browsers that this page supports both dark and light color schemes,
and the page author prefers light. --><meta name="color-scheme" content="dark light"><script>
// If `prefers-color-scheme` is not supported, fall back to light mode.
// i.e. In this case, inject the `light` CSS before the others, with
// no media filter so that it will be downloaded with highest priority.
if (window.matchMedia("(prefers-color-scheme: dark)").media === "not all") {
document.documentElement.style.display = "none";
document.head.insertAdjacentHTML(
"beforeend",
"<link id=\"css\" rel=\"stylesheet\" href=\"https://bootswatch.com/5/flatly/bootstrap.css\" onload=\"document.documentElement.style.display = ''\">"
);
}
</script><title>R6 Class containing national level methods — CountryDataClass • covidregionaldata</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"><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.1.0/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.0/bootstrap.bundle.min.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"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></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><!-- 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><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="R6 Class containing national level methods — CountryDataClass"><meta property="og:description" content="Acts as parent class for national data classes, allowing them
to access general methods defined in DataClass() but with additional"><meta property="og:image" content="https://epiforecasts.io/covidregionaldata/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]--><!-- Flatly Theme - Light --><link id="css-light" rel="stylesheet" href="https://bootswatch.com/5/flatly/bootstrap.css" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"><!-- Darkly Theme - Dark --><link id="css-dark" rel="stylesheet" href="https://bootswatch.com/5/darkly/bootstrap.css" media="(prefers-color-scheme: dark)"><!-- preferably CSS --><link rel="stylesheet" href="../preferably.css"><link id="css-code-light" rel="stylesheet" href="../code-color-scheme-light.css" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"><link id="css-code-dark" rel="stylesheet" href="../code-color-scheme-dark.css" media="(prefers-color-scheme: dark)"><script src="../darkswitch.js"></script></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
<a class="navbar-brand me-2" href="../index.html">covidregionaldata</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">0.9.3</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-2">
<ul class="navbar-nav me-auto"><li class="nav-item">
<a class="nav-link" href="../index.html">Home</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../articles/quickstart.html">Getting Started</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../articles/supported-countries.html">Supported countries</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-other-articles">Other Articles</a>
<div class="dropdown-menu" aria-labelledby="dropdown-other-articles">
<a class="dropdown-item" href="../articles/slowstart.html">Package Overview</a>
<a class="dropdown-item" href="../articles/testing.html">Testing Datasets</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="../news/index.html">News</a>
</li>
<li class="active nav-item">
<a class="nav-link" href="../reference/index.html">
<span class="fa fa-file-code-o"></span>
Functions
</a>
</li>
</ul><form class="form-inline my-2 my-lg-0" role="search">
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
<ul class="navbar-nav"><li class="nav-item">
<a class="external-link nav-link" href="https://github.com/epiforecasts/covidregionaldata/" aria-label="github">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
<li>
<a class="external-link nav-link" id="css-toggle-btn" aria-label="github">
<span class="fas fa fas fa-adjust 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">
<img src="../logo.png" class="logo" alt=""><h1>R6 Class containing national level methods</h1>
<small class="dont-index">Source: <a href="https://github.com/epiforecasts/covidregionaldata/blob/HEAD/R/shared-methods.R" class="external-link"><code>R/shared-methods.R</code></a></small>
<div class="d-none name"><code>CountryDataClass.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Acts as parent class for national data classes, allowing them
to access general methods defined in <code><a href="DataClass.html">DataClass()</a></code> but with additional</p>
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
<p>On top of the methods documented in <code><a href="DataClass.html">DataClass()</a></code>, this class
implements a custom filter function that supports partial matching to
English country names using the <code>countrycode</code> package.</p>
</div>
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
<div class="dont-index"><p>Data interface functions
<code><a href="DataClass.html">DataClass</a></code>,
<code><a href="get_available_datasets.html">get_available_datasets</a>()</code>,
<code><a href="get_national_data.html">get_national_data</a>()</code>,
<code><a href="get_regional_data.html">get_regional_data</a>()</code>,
<code><a href="initialise_dataclass.html">initialise_dataclass</a>()</code></p></div>
</div>
<div class="section level2">
<h2 id="super-class">Super class<a class="anchor" aria-label="anchor" href="#super-class"></a></h2>
<p><code><a href="DataClass.html">covidregionaldata::DataClass</a></code> -> <code>CountryDataClass</code></p>
</div>
<div class="section level2">
<h2 id="public-fields">Public fields<a class="anchor" aria-label="anchor" href="#public-fields"></a></h2>
<p></p><div class="r6-fields"><dl><dt><code>filter_level</code></dt>
<dd><p>Character The level of the data to filter at.
Defaults to the country level of the data.</p></dd>
</dl><p></p></div>
</div>
<div class="section level2">
<h2 id="methods">Methods<a class="anchor" aria-label="anchor" href="#methods"></a></h2>
<div class="section">
<h3 id="public-methods">Public methods<a class="anchor" aria-label="anchor" href="#public-methods"></a></h3>
<ul><li><p><a href="#method-filter"><code>CountryDataClass$filter()</code></a></p></li>
<li><p><a href="#method-clone"><code>CountryDataClass$clone()</code></a></p></li>
</ul></div><p><details><summary>Inherited methods</summary><ul><li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="available_regions"><a href="DataClass.html#method-available_regions"><code>covidregionaldata::DataClass$available_regions()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="clean"><a href="DataClass.html#method-clean"><code>covidregionaldata::DataClass$clean()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="clean_common"><a href="DataClass.html#method-clean_common"><code>covidregionaldata::DataClass$clean_common()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="download"><a href="DataClass.html#method-download"><code>covidregionaldata::DataClass$download()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="download_JSON"><a href="DataClass.html#method-download_JSON"><code>covidregionaldata::DataClass$download_JSON()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="get"><a href="DataClass.html#method-get"><code>covidregionaldata::DataClass$get()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="initialize"><a href="DataClass.html#method-initialize"><code>covidregionaldata::DataClass$initialize()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="process"><a href="DataClass.html#method-process"><code>covidregionaldata::DataClass$process()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="return"><a href="DataClass.html#method-return"><code>covidregionaldata::DataClass$return()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="set_region_codes"><a href="DataClass.html#method-set_region_codes"><code>covidregionaldata::DataClass$set_region_codes()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="summary"><a href="DataClass.html#method-summary"><code>covidregionaldata::DataClass$summary()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="covidregionaldata" data-topic="DataClass" data-id="test"><a href="DataClass.html#method-test"><code>covidregionaldata::DataClass$test()</code></a></span></p></li>
</ul></details></p><hr><a id="method-filter"></a><div class="section">
<h3 id="method-filter-">Method <code><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter()</a></code><a class="anchor" aria-label="anchor" href="#method-filter-"></a></h3>
<p>Filter method for country level data. Uses <code>countryname</code>
to match input countries with known names.</p><div class="section">
<h4 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span class="va">CountryDataClass</span><span class="op">$</span><span class="fu">filter</span><span class="op">(</span><span class="va">countries</span>, <span class="va">level</span><span class="op">)</span></code></pre></div><p></p></div>
</div>
<div class="section">
<h4 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h4>
<p></p><div class="arguments"><dl><dt><code>countries</code></dt>
<dd><p>A character vector of target countries. Overrides the
current class setting for <code>target_regions</code>. If the <code>filter_level</code> field
<code>level</code> argument is set to anything other than level 1 this is passed
directly to the parent <code><a href="DataClass.html">DataClass()</a></code> <code><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter()</a></code> method with no
alteration.</p></dd>
<dt><code>level</code></dt>
<dd><p>Character The level of the data to filter at. Defaults to
the conuntry level if not specified.</p></dd>
</dl><p></p></div>
</div>
</div><p></p><hr><a id="method-clone"></a><div class="section">
<h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section">
<h4 id="usage-1">Usage<a class="anchor" aria-label="anchor" href="#usage-1"></a></h4>
<p></p><div class="r"><div class="sourceCode"><pre><code><span class="va">CountryDataClass</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></code></pre></div><p></p></div>
</div>
<div class="section">
<h4 id="arguments-1">Arguments<a class="anchor" aria-label="anchor" href="#arguments-1"></a></h4>
<p></p><div class="arguments"><dl><dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>
</dl><p></p></div>
</div>
</div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="copyright">
<p></p><p>Developed by Joseph Palmer, Katharine Sherratt, Richard Martin-Nielsen, Jonnie Bevan, Hamish Gibbs, Hugo Gruson, <a href="https://www.lshtm.ac.uk/aboutus/people/funk.sebastian" class="external-link">Sebastian Funk</a>, <a href="https://www.samabbott.co.uk/" class="external-link">Sam Abbott</a>.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.9000.</p>
<p class="preferably">Using <a href="https://preferably.amirmasoudabdol.name/?source=footer" class="external-link">preferably</a> template.</p>
</div>
</footer></div>
</body></html>