diff --git a/404.html b/404.html
index 86821e2..4efb980 100644
--- a/404.html
+++ b/404.html
@@ -28,7 +28,7 @@
 
     <a class="navbar-brand me-2" href="https://dfe-analytical-services.github.io/dfeR/index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html
index fc1e7ad..ebd9cd0 100644
--- a/CODE_OF_CONDUCT.html
+++ b/CODE_OF_CONDUCT.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="logo.png" class="logo" alt=""><h1>Contributor Covenant Code of Conduct</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/.github/CODE_OF_CONDUCT.md" class="external-link"><code>.github/CODE_OF_CONDUCT.md</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/.github/CODE_OF_CONDUCT.md" class="external-link"><code>.github/CODE_OF_CONDUCT.md</code></a></small>
     </div>
 
 <div id="contributor-covenant-code-of-conduct" class="section level1">
diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html
index 1771d90..9905393 100644
--- a/CONTRIBUTING.html
+++ b/CONTRIBUTING.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="logo.png" class="logo" alt=""><h1>Contributing to dfeR</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/.github/CONTRIBUTING.md" class="external-link"><code>.github/CONTRIBUTING.md</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/.github/CONTRIBUTING.md" class="external-link"><code>.github/CONTRIBUTING.md</code></a></small>
     </div>
 
 <div id="contributing-to-dfer" class="section level1">
diff --git a/LICENSE.html b/LICENSE.html
index 3b995a1..0153367 100644
--- a/LICENSE.html
+++ b/LICENSE.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="logo.png" class="logo" alt=""><h1>GNU General Public License</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/LICENSE.md" class="external-link"><code>LICENSE.md</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/LICENSE.md" class="external-link"><code>LICENSE.md</code></a></small>
     </div>
 
 <div id="gnu-general-public-license" class="section level1">
diff --git a/PULL_REQUEST_TEMPLATE.html b/PULL_REQUEST_TEMPLATE.html
index 23ed665..78324de 100644
--- a/PULL_REQUEST_TEMPLATE.html
+++ b/PULL_REQUEST_TEMPLATE.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="logo.png" class="logo" alt=""><h1>Brief overview of changes</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/.github/PULL_REQUEST_TEMPLATE.md" class="external-link"><code>.github/PULL_REQUEST_TEMPLATE.md</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/.github/PULL_REQUEST_TEMPLATE.md" class="external-link"><code>.github/PULL_REQUEST_TEMPLATE.md</code></a></small>
     </div>
 
 <div id="brief-overview-of-changes" class="section level1">
diff --git a/articles/connecting_to_sql.html b/articles/connecting_to_sql.html
index c91b8b5..21ee585 100644
--- a/articles/connecting_to_sql.html
+++ b/articles/connecting_to_sql.html
@@ -27,7 +27,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -65,7 +65,7 @@
       <img src="../logo.png" class="logo" alt=""><h1>Connecting to SQL</h1>
             
       
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/vignettes/connecting_to_sql.Rmd" class="external-link"><code>vignettes/connecting_to_sql.Rmd</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/vignettes/connecting_to_sql.Rmd" class="external-link"><code>vignettes/connecting_to_sql.Rmd</code></a></small>
       <div class="d-none name"><code>connecting_to_sql.Rmd</code></div>
     </div>
 
diff --git a/articles/index.html b/articles/index.html
index 2a52e7f..d90e5fb 100644
--- a/articles/index.html
+++ b/articles/index.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
diff --git a/authors.html b/authors.html
index 592a3fe..aa05d48 100644
--- a/authors.html
+++ b/authors.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -69,18 +69,18 @@ <h2>Authors</h2>
 
     <div class="section level2">
       <h2 id="citation">Citation</h2>
-      <p><small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/DESCRIPTION" class="external-link"><code>DESCRIPTION</code></a></small></p>
+      <p><small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/DESCRIPTION" class="external-link"><code>DESCRIPTION</code></a></small></p>
 
       <p>Race C, Selby L, Robinson A (2024).
 <em>dfeR: Common DfE R tasks</em>.
-R package version 0.6.0,
+R package version 0.6.1,
 https://github.com/dfe-analytical-services/dfeR, <a href="https://dfe-analytical-services.github.io/dfeR/">https://dfe-analytical-services.github.io/dfeR/</a>.
 </p>
       <pre>@Manual{,
   title = {dfeR: Common DfE R tasks},
   author = {Cam Race and Laura Selby and Adam Robinson},
   year = {2024},
-  note = {R package version 0.6.0,
+  note = {R package version 0.6.1,
     https://github.com/dfe-analytical-services/dfeR},
   url = {https://dfe-analytical-services.github.io/dfeR/},
 }</pre>
diff --git a/index.html b/index.html
index 8a9d3bd..c04296a 100644
--- a/index.html
+++ b/index.html
@@ -30,7 +30,7 @@
 
     <a class="navbar-brand me-2" href="index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
diff --git a/news/index.html b/news/index.html
index 1a5f281..44b9aca 100644
--- a/news/index.html
+++ b/news/index.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,9 +32,13 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Changelog</h1>
-      <small>Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
+      <small>Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
     </div>
 
+    <div class="section level2">
+<h2 class="pkg-version" data-toc-text="0.6.1" id="dfer-061">dfeR 0.6.1<a class="anchor" aria-label="anchor" href="#dfer-061"></a></h2>
+<p>Patch to update the pretty_num() function so that the <code>dp</code> argument’s default is 0.</p>
+</div>
     <div class="section level2">
 <h2 class="pkg-version" data-toc-text="0.6.0" id="dfer-060">dfeR 0.6.0<a class="anchor" aria-label="anchor" href="#dfer-060"></a></h2>
 <p>Update pretty_num so that:</p>
diff --git a/pkgdown.yml b/pkgdown.yml
index 4f23211..e30221f 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.1
 pkgdown_sha: ~
 articles:
   connecting_to_sql: connecting_to_sql.html
-last_built: 2024-10-15T12:26Z
+last_built: 2024-10-17T07:09Z
 urls:
   reference: https://dfe-analytical-services.github.io/dfeR/reference
   article: https://dfe-analytical-services.github.io/dfeR/articles
diff --git a/reference/check_fetch_location_inputs.html b/reference/check_fetch_location_inputs.html
index de2d0d6..9008ac8 100644
--- a/reference/check_fetch_location_inputs.html
+++ b/reference/check_fetch_location_inputs.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Validation for fetch location lookups</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch_utils.R" class="external-link"><code>R/fetch_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch_utils.R" class="external-link"><code>R/fetch_utils.R</code></a></small>
       <div class="d-none name"><code>check_fetch_location_inputs.Rd</code></div>
     </div>
 
diff --git a/reference/comma_sep.html b/reference/comma_sep.html
index 98e53a8..a862fa5 100644
--- a/reference/comma_sep.html
+++ b/reference/comma_sep.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Comma separate</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/comma_sep.R" class="external-link"><code>R/comma_sep.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/comma_sep.R" class="external-link"><code>R/comma_sep.R</code></a></small>
       <div class="d-none name"><code>comma_sep.Rd</code></div>
     </div>
 
diff --git a/reference/countries.html b/reference/countries.html
index ce1daca..377c034 100644
--- a/reference/countries.html
+++ b/reference/countries.html
@@ -11,7 +11,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -36,7 +36,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Lookup for valid country names and codes</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
       <div class="d-none name"><code>countries.Rd</code></div>
     </div>
 
diff --git a/reference/create_project.html b/reference/create_project.html
index f562108..5c540e0 100644
--- a/reference/create_project.html
+++ b/reference/create_project.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Creates a pre-populated project for DfE R</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/create_project.R" class="external-link"><code>R/create_project.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/create_project.R" class="external-link"><code>R/create_project.R</code></a></small>
       <div class="d-none name"><code>create_project.Rd</code></div>
     </div>
 
diff --git a/reference/create_time_series_lookup.html b/reference/create_time_series_lookup.html
index 29f7bb9..7a562e6 100644
--- a/reference/create_time_series_lookup.html
+++ b/reference/create_time_series_lookup.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Smush lookups together to make a time series</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
       <div class="d-none name"><code>create_time_series_lookup.Rd</code></div>
     </div>
 
diff --git a/reference/dfeR-package.html b/reference/dfeR-package.html
index 9cc6687..802233b 100644
--- a/reference/dfeR-package.html
+++ b/reference/dfeR-package.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>dfeR: Common DfE R tasks</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/dfeR-package.R" class="external-link"><code>R/dfeR-package.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/dfeR-package.R" class="external-link"><code>R/dfeR-package.R</code></a></small>
       <div class="d-none name"><code>dfeR-package.Rd</code></div>
     </div>
 
diff --git a/reference/fetch.html b/reference/fetch.html
index 325697b..0098a75 100644
--- a/reference/fetch.html
+++ b/reference/fetch.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch Westminster parliamentary constituencies</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_countries.html b/reference/fetch_countries.html
index 90a8e57..f9443d9 100644
--- a/reference/fetch_countries.html
+++ b/reference/fetch_countries.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch countries</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch_countries.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_lads.html b/reference/fetch_lads.html
index 8bc63e3..ec300ea 100644
--- a/reference/fetch_lads.html
+++ b/reference/fetch_lads.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch local authority districts</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch_lads.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_las.html b/reference/fetch_las.html
index 1089946..fbf4100 100644
--- a/reference/fetch_las.html
+++ b/reference/fetch_las.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch local authorities</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch_las.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_locations.html b/reference/fetch_locations.html
index 986421b..8ba03fe 100644
--- a/reference/fetch_locations.html
+++ b/reference/fetch_locations.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch locations for a given lookup</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch_utils.R" class="external-link"><code>R/fetch_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch_utils.R" class="external-link"><code>R/fetch_utils.R</code></a></small>
       <div class="d-none name"><code>fetch_locations.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_regions.html b/reference/fetch_regions.html
index ce7b4e4..a89eb99 100644
--- a/reference/fetch_regions.html
+++ b/reference/fetch_regions.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch regions</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch_regions.Rd</code></div>
     </div>
 
diff --git a/reference/fetch_wards.html b/reference/fetch_wards.html
index 77712e4..90e7c3c 100644
--- a/reference/fetch_wards.html
+++ b/reference/fetch_wards.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch wards</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/fetch.R" class="external-link"><code>R/fetch.R</code></a></small>
       <div class="d-none name"><code>fetch_wards.Rd</code></div>
     </div>
 
diff --git a/reference/format_ay.html b/reference/format_ay.html
index e01f3eb..ae452e6 100644
--- a/reference/format_ay.html
+++ b/reference/format_ay.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Format academic year</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/format.R" class="external-link"><code>R/format.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/format.R" class="external-link"><code>R/format.R</code></a></small>
       <div class="d-none name"><code>format_ay.Rd</code></div>
     </div>
 
diff --git a/reference/format_ay_reverse.html b/reference/format_ay_reverse.html
index a015743..6f47404 100644
--- a/reference/format_ay_reverse.html
+++ b/reference/format_ay_reverse.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Undo academic year formatting</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/format.R" class="external-link"><code>R/format.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/format.R" class="external-link"><code>R/format.R</code></a></small>
       <div class="d-none name"><code>format_ay_reverse.Rd</code></div>
     </div>
 
diff --git a/reference/format_fy.html b/reference/format_fy.html
index fca5a2e..c581979 100644
--- a/reference/format_fy.html
+++ b/reference/format_fy.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Format financial year</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/format.R" class="external-link"><code>R/format.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/format.R" class="external-link"><code>R/format.R</code></a></small>
       <div class="d-none name"><code>format_fy.Rd</code></div>
     </div>
 
diff --git a/reference/format_fy_reverse.html b/reference/format_fy_reverse.html
index 0774a1d..728bf51 100644
--- a/reference/format_fy_reverse.html
+++ b/reference/format_fy_reverse.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Undo financial year formatting</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/format.R" class="external-link"><code>R/format.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/format.R" class="external-link"><code>R/format.R</code></a></small>
       <div class="d-none name"><code>format_fy_reverse.Rd</code></div>
     </div>
 
diff --git a/reference/get_clean_sql.html b/reference/get_clean_sql.html
index 4cdb535..06cc212 100644
--- a/reference/get_clean_sql.html
+++ b/reference/get_clean_sql.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Get a cleaned SQL script into R</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/get_clean_sql.R" class="external-link"><code>R/get_clean_sql.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/get_clean_sql.R" class="external-link"><code>R/get_clean_sql.R</code></a></small>
       <div class="d-none name"><code>get_clean_sql.Rd</code></div>
     </div>
 
diff --git a/reference/get_lad_region.html b/reference/get_lad_region.html
index ed3eb66..6dc3ba3 100644
--- a/reference/get_lad_region.html
+++ b/reference/get_lad_region.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Get LAD to Region lookup</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
       <div class="d-none name"><code>get_lad_region.Rd</code></div>
     </div>
 
diff --git a/reference/get_ons_api_data.html b/reference/get_ons_api_data.html
index fa948e2..69d90da 100644
--- a/reference/get_ons_api_data.html
+++ b/reference/get_ons_api_data.html
@@ -11,7 +11,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -36,7 +36,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Fetch ONS Open Geography API data</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/get_ons_api_data.R" class="external-link"><code>R/get_ons_api_data.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/get_ons_api_data.R" class="external-link"><code>R/get_ons_api_data.R</code></a></small>
       <div class="d-none name"><code>get_ons_api_data.Rd</code></div>
     </div>
 
diff --git a/reference/get_wd_pcon_lad_la.html b/reference/get_wd_pcon_lad_la.html
index 8880268..9867d20 100644
--- a/reference/get_wd_pcon_lad_la.html
+++ b/reference/get_wd_pcon_lad_la.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Get Ward-PCon-LAD-LA data</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
       <div class="d-none name"><code>get_wd_pcon_lad_la.Rd</code></div>
     </div>
 
diff --git a/reference/index.html b/reference/index.html
index 69134a3..c2a8240 100644
--- a/reference/index.html
+++ b/reference/index.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
diff --git a/reference/ons_geog_shorthands.html b/reference/ons_geog_shorthands.html
index 91d22cb..4a04ced 100644
--- a/reference/ons_geog_shorthands.html
+++ b/reference/ons_geog_shorthands.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Lookup for ONS geography columns shorthands</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
       <div class="d-none name"><code>ons_geog_shorthands.Rd</code></div>
     </div>
 
diff --git a/reference/pretty_filesize.html b/reference/pretty_filesize.html
index dfcf516..9258bf5 100644
--- a/reference/pretty_filesize.html
+++ b/reference/pretty_filesize.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Pretty numbers into readable file size</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
       <div class="d-none name"><code>pretty_filesize.Rd</code></div>
     </div>
 
diff --git a/reference/pretty_num.html b/reference/pretty_num.html
index bde8d23..566ccc6 100644
--- a/reference/pretty_num.html
+++ b/reference/pretty_num.html
@@ -1,7 +1,7 @@
 <!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>Prettify big numbers into a readable format — pretty_num • dfeR</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.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><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Prettify big numbers into a readable format — pretty_num"><meta name="description" content='Uses as.numeric() to force a numeric value and then formats prettily
 for easy presentation in console messages, reports, or dashboards.
-This rounds to 2 decimal places by default, and adds in comma separators.
+This rounds to 0 decimal places by default, and adds in comma separators.
 Expect that this will commonly be used for adding the pound symbol,
 the percentage symbol, or to have a +/- prefixed based on the value.
 If applying over multiple or unpredictable values and you want to preserve
@@ -11,7 +11,7 @@
 argument.
 This function silences the warning around NAs being introduced by coercion.'><meta property="og:description" content='Uses as.numeric() to force a numeric value and then formats prettily
 for easy presentation in console messages, reports, or dashboards.
-This rounds to 2 decimal places by default, and adds in comma separators.
+This rounds to 0 decimal places by default, and adds in comma separators.
 Expect that this will commonly be used for adding the pound symbol,
 the percentage symbol, or to have a +/- prefixed based on the value.
 If applying over multiple or unpredictable values and you want to preserve
@@ -27,7 +27,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -52,14 +52,14 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Prettify big numbers into a readable format</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
       <div class="d-none name"><code>pretty_num.Rd</code></div>
     </div>
 
     <div class="ref-description section level2">
     <p>Uses <code><a href="https://rdrr.io/r/base/numeric.html" class="external-link">as.numeric()</a></code> to force a numeric value and then formats prettily
 for easy presentation in console messages, reports, or dashboards.</p>
-<p>This rounds to 2 decimal places by default, and adds in comma separators.</p>
+<p>This rounds to 0 decimal places by default, and adds in comma separators.</p>
 <p>Expect that this will commonly be used for adding the pound symbol,
 the percentage symbol, or to have a +/- prefixed based on the value.</p>
 <p>If applying over multiple or unpredictable values and you want to preserve
@@ -77,7 +77,7 @@ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage">
 <span>  prefix <span class="op">=</span> <span class="st">""</span>,</span>
 <span>  gbp <span class="op">=</span> <span class="cn">FALSE</span>,</span>
 <span>  suffix <span class="op">=</span> <span class="st">""</span>,</span>
-<span>  dp <span class="op">=</span> <span class="fl">2</span>,</span>
+<span>  dp <span class="op">=</span> <span class="fl">0</span>,</span>
 <span>  ignore_na <span class="op">=</span> <span class="cn">FALSE</span>,</span>
 <span>  alt_na <span class="op">=</span> <span class="cn">FALSE</span>,</span>
 <span>  nsmall <span class="op">=</span> <span class="cn">NULL</span></span>
@@ -106,7 +106,7 @@ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#argumen
 
 
 <dt id="arg-dp">dp<a class="anchor" aria-label="anchor" href="#arg-dp"></a></dt>
-<dd><p>number of decimal places to round to, 2 by default</p></dd>
+<dd><p>number of decimal places to round to, 0 by default.</p></dd>
 
 
 <dt id="arg-ignore-na">ignore_na<a class="anchor" aria-label="anchor" href="#arg-ignore-na"></a></dt>
@@ -119,7 +119,9 @@ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#argumen
 
 
 <dt id="arg-nsmall">nsmall<a class="anchor" aria-label="anchor" href="#arg-nsmall"></a></dt>
-<dd><p>minimum number of digits to the right of the decimal point</p></dd>
+<dd><p>minimum number of digits to the right of the decimal point.
+If NULL, the value of <code>dp</code> will be used.
+If  value of <code>dp</code> is less than 0, then <code>nsmall</code> will automatically be set to 0.</p></dd>
 
 </dl></div>
     <div class="section level2">
@@ -139,11 +141,11 @@ <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"
     <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"># On individual values</span></span></span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="fl">5789</span>, gbp <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "£5,789.00"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "£5,789"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="fl">564</span>, prefix <span class="op">=</span> <span class="st">"+/-"</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+564.00"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+564"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="fl">567812343223</span>, gbp <span class="op">=</span> <span class="cn">TRUE</span>, prefix <span class="op">=</span> <span class="st">"+/-"</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+£567.81 billion"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+£568 billion"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="fl">11</span><span class="op">^</span><span class="fl">9</span>, gbp <span class="op">=</span> <span class="cn">TRUE</span>, dp <span class="op">=</span> <span class="fl">3</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> [1] "£2.358 billion"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="op">-</span><span class="fl">11</span><span class="op">^</span><span class="fl">8</span>, gbp <span class="op">=</span> <span class="cn">TRUE</span>, dp <span class="op">=</span> <span class="op">-</span><span class="fl">1</span><span class="op">)</span></span></span>
@@ -151,7 +153,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="fl">43.3</span>, dp <span class="op">=</span> <span class="fl">1</span>, nsmall <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> [1] "43.30"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="st">"56.089"</span>, suffix <span class="op">=</span> <span class="st">"%"</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "56.09%"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "56%"</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="st">"x"</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> [1] NA</span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="st">"x"</span>, ignore_na <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
@@ -162,17 +164,17 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
 <span class="r-in"><span><span class="co"># Applied over an example vector</span></span></span>
 <span class="r-in"><span><span class="va">vector</span> <span class="op">&lt;-</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">3998098008</span>, <span class="op">-</span><span class="fl">123421421</span>, <span class="st">"c"</span>, <span class="st">"x"</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="va">vector</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4.00 billion"    "-123.42 million" NA                NA               </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4 billion"    "-123 million" NA             NA            </span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="va">vector</span>, prefix <span class="op">=</span> <span class="st">"+/-"</span>, gbp <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+£4.00 billion"   "-£123.42 million" NA                 NA                </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "+£4 billion"   "-£123 million" NA              NA             </span>
 <span class="r-in"><span></span></span>
 <span class="r-in"><span><span class="co"># Return original values if NA</span></span></span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="va">vector</span>, ignore_na <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4.00 billion"    "-123.42 million" "c"               "x"              </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4 billion"    "-123 million" "c"            "x"           </span>
 <span class="r-in"><span></span></span>
 <span class="r-in"><span><span class="co"># Return alternative value in place of NA</span></span></span>
 <span class="r-in"><span><span class="fu">pretty_num</span><span class="op">(</span><span class="va">vector</span>, alt_na <span class="op">=</span> <span class="st">"z"</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4.00 billion"    "-123.42 million" "z"               "z"              </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "4 billion"    "-123 million" "z"            "z"           </span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/reference/pretty_num_table.html b/reference/pretty_num_table.html
index 62c93bf..344bb33 100644
--- a/reference/pretty_num_table.html
+++ b/reference/pretty_num_table.html
@@ -13,7 +13,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -38,7 +38,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Format a data frame with <code>dfeR::pretty_num()</code>.</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
       <div class="d-none name"><code>pretty_num_table.Rd</code></div>
     </div>
 
diff --git a/reference/pretty_time_taken.html b/reference/pretty_time_taken.html
index b8bcb19..85a22e4 100644
--- a/reference/pretty_time_taken.html
+++ b/reference/pretty_time_taken.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Calculate elapsed time between two points and present prettily</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/pretty.R" class="external-link"><code>R/pretty.R</code></a></small>
       <div class="d-none name"><code>pretty_time_taken.Rd</code></div>
     </div>
 
diff --git a/reference/regions.html b/reference/regions.html
index 7c304d7..29923a2 100644
--- a/reference/regions.html
+++ b/reference/regions.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Lookup for valid region names and codes</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
       <div class="d-none name"><code>regions.Rd</code></div>
     </div>
 
diff --git a/reference/round_five_up.html b/reference/round_five_up.html
index 770723e..cdda9c0 100644
--- a/reference/round_five_up.html
+++ b/reference/round_five_up.html
@@ -7,7 +7,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -32,7 +32,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Round five up</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/round_five_up.R" class="external-link"><code>R/round_five_up.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/round_five_up.R" class="external-link"><code>R/round_five_up.R</code></a></small>
       <div class="d-none name"><code>round_five_up.Rd</code></div>
     </div>
 
diff --git a/reference/tidy_raw_lookup.html b/reference/tidy_raw_lookup.html
index 08d509b..f47d6a2 100644
--- a/reference/tidy_raw_lookup.html
+++ b/reference/tidy_raw_lookup.html
@@ -9,7 +9,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -34,7 +34,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Tidy a lookup file from the Open Geography Portal</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_utils.R" class="external-link"><code>R/datasets_utils.R</code></a></small>
       <div class="d-none name"><code>tidy_raw_lookup.Rd</code></div>
     </div>
 
diff --git a/reference/toggle_message.html b/reference/toggle_message.html
index 4769532..194c495 100644
--- a/reference/toggle_message.html
+++ b/reference/toggle_message.html
@@ -11,7 +11,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -36,7 +36,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Controllable console messages</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/toggle_message.R" class="external-link"><code>R/toggle_message.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/toggle_message.R" class="external-link"><code>R/toggle_message.R</code></a></small>
       <div class="d-none name"><code>toggle_message.Rd</code></div>
     </div>
 
diff --git a/reference/wd_pcon_lad_la_rgn_ctry.html b/reference/wd_pcon_lad_la_rgn_ctry.html
index c2f43a2..812dd80 100644
--- a/reference/wd_pcon_lad_la_rgn_ctry.html
+++ b/reference/wd_pcon_lad_la_rgn_ctry.html
@@ -11,7 +11,7 @@
 
     <a class="navbar-brand me-2" href="../index.html">dfeR</a>
 
-    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small>
+    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.1</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">
@@ -36,7 +36,7 @@
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="../logo.png" class="logo" alt=""><h1>Ward to Constituency to LAD to LA to Region to Country lookup</h1>
-      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/v0.6.0/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
+      <small class="dont-index">Source: <a href="https://github.com/dfe-analytical-services/dfeR/blob/main/R/datasets_documentation.R" class="external-link"><code>R/datasets_documentation.R</code></a></small>
       <div class="d-none name"><code>wd_pcon_lad_la_rgn_ctry.Rd</code></div>
     </div>
 
diff --git a/search.json b/search.json
index df2222f..1cbd39b 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement statistics.development@education.gov.uk. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to dfeR","title":"Contributing to dfeR","text":"Ideas dfeR first raised GitHub issue anyone free write code create pull request review. detailed discussion contributing R packages tidyverse, please see development contributing guide code review principles. Full knowledge isn’t needed, though awareness general principles may useful.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"support","dir":"","previous_headings":"","what":"Support","title":"Contributing to dfeR","text":"’re keen anyone DfE able feel comfortable contributing package. questions, like support making changes, let Statistics Development Team know.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"basics","dir":"","previous_headings":"","what":"Basics","title":"Contributing to dfeR","text":"contributing dfeR work new branch taken main. pull request must reviewed approved least one admin user can merged. ’ve found bug, please file issue illustrates bug minimal reprex example (also help write unit test, needed). See tidyverse guide create great issue advice.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"Basics","what":"Fixing typos","title":"Contributing to dfeR","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"Basics","what":"Bigger changes","title":"Contributing to dfeR","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees change. Packages worth installing aid development : possible, ’d recommend following Test Driven Development (TDD) approach. Though ’re new package development, already code specific function feel free start step 2, copy function package go back step 1 afterwards. Write tests using testthat behaviour want. Either edit existing test script, adding new function, create test script using: Feel free look /tests/test_that folder examples want see example tests practice. Write just enough code tests pass. , either edit existing function, add new R script using: Add documentation ’ve done. Follow roxygen2 pattern comments. can add standard skeleton using Code > Insert Roxygen Skeleton Ctrl+Shift+Alt+R R script. ’s example looks like basic add() function: Continue improve code keeping tests passing. Automatically style code using: Run full check package using following functions:","code":"install.packages(\"devtools\") install.packages(\"usethis\") install.packages(\"pkgdown\") install.packages(\"roxygen2\") install.packages(\"spelling\") install.packages(\"lintr\") install.packages(\"styler\") usethis::use_test(\"name_of_new_function\") usethis::use_r(\"name_of_new_function\") #' @description Add together two numbers #' #' @param x A number. #' @param y A number. #' @return A number. #' @examples #' add(1, 1) #' add(10, 1) add <- function(x, y) {   x + y } styler::style_pkg() devtools::check() # General package check, can also use Ctrl-Shift-E lintr::lint_package() # Check formatting of code spelling::spell_check() # Check for spelling mistakes"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"handy-workflows","dir":"","previous_headings":"","what":"Handy workflows","title":"Contributing to dfeR","text":"Keyboard shortcuts devtools package use RStudio: recommend using usethis package possible consistency simplicity.","code":"load_all() # (Ctrl-Shift-L): Load code with dfeR package test() # (Ctrl-Shift-T): Run tests document() # (Ctrl-Shift-D): Rebuild docs and NAMESPACE check() # (Ctrl-Shift-E): Check complete package"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"adding-package-dependencies","dir":"","previous_headings":"","what":"Adding package dependencies","title":"Contributing to dfeR","text":"Add packages package users need : Add packages package developers may need :","code":"usethis::use_package(pkgname) usethis::use_package(pkgname, type = \"suggests\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"updating-the-readme","dir":"","previous_headings":"","what":"Updating the README","title":"Contributing to dfeR","text":"two README files linked pre-commit-hook ensure kept sync. Make changes README.Rmd file run following line rebuild:","code":"devtools::build_readme()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"pkgdown-site","dir":"","previous_headings":"","what":"pkgdown site","title":"Contributing to dfeR","text":"pkgdown site automatically generated. theme set _pkgdown.yml file. Custom CSS can set pkgdown/extra.css file. make edits file need re-initialise site using following line: site hosted GitHub pages. build preview pkgdown site locally running:","code":"pkgdown::init_site() devtools::build_site()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"updating-the-package-version","dir":"","previous_headings":"","what":"Updating the package version","title":"Contributing to dfeR","text":"changes completed, reviewed ready use wild, can increment package version using: unsure kind version increment, look lifecycle’s guidance release types. ’ve incremented version number, ’ll offer perform commit behalf. happens add update NEWS.md, acts changelog package. Make sure updated correctly push GitHub. version updated pushed, create new GitHub release version.","code":"usethis::use_version()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"lifecyles","dir":"","previous_headings":"Updating the package version","what":"Lifecyles","title":"Contributing to dfeR","text":"package lifecycle imported, follow guidance process around deprecating functions arguments.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"","what":"Code style","title":"Contributing to dfeR","text":"New code follow tidyverse style guide. use lintr scan styling pull requests, automatically run add comments code failing standards ’d expect. happen, please proactively resolve unlikely approve pull requests styling issues. can use styler package apply styling using: check styling issues locally, use: styler fix linting issues, recommend using first, using lintr check places may need manually fix styling issues line length using snake_case.","code":"styler::style_pkg() lintr::lint_package()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"folder-and-script-structure-conventions","dir":"","previous_headings":"","what":"Folder and script structure conventions","title":"Contributing to dfeR","text":"R package allowed sub directories R/ folder. possible : one script per function one script per function family function belongs family script share name function family. needed _utils.R script used internal functions relate specific family. Documentation data shipped packages kept R/datasets_documentation.R. Scripts used preparing data used package R folder, data-raw/ folder, helper functions can found R/datasets_utils.R folder, details maintaining data sets can found Package data header page. utils.R used hold cross-package helpers aren’t exported functions specific family. Every exported function data set gets test script, called test-<function-name>.R test-data-<data-name>.R data set.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"testing","dir":"","previous_headings":"Folder and script structure conventions","what":"Testing","title":"Contributing to dfeR","text":"use testthat unit tests, expect new functions level test coverage. want see examples existing tests inspiration, take look inside tests/testthat/ folder.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"test-coverage","dir":"","previous_headings":"Folder and script structure conventions","what":"Test coverage","title":"Contributing to dfeR","text":"GitHub Actions workflows check link package codecov.io, runs automatic scans check % lines functions testing. dfeR codecov pages can preview variation branch commit see impact changes made. need create account login using GitHub see pages. current % coverage shown badge package README GitHub. worth noting 100% coverage mean tests perfect, means lines ran tests, ’s measure quantity rather quality. Interesting see though, ’d recommend using spot potential elements complicated functions may forgotten test.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"spelling","dir":"","previous_headings":"Folder and script structure conventions","what":"Spelling","title":"Contributing to dfeR","text":"spelling package used check spelling. custom word list exceptions package exists inst/ folder. messages devtools::check() output ’s potential spelling errors. Please review fix genuine errors. can run check using: automatically pick genuine new words package add list, use:","code":"spelling::spell_check_package() spelling::update_wordlist()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"adding-vignettes","dir":"","previous_headings":"","what":"Adding vignettes","title":"Contributing to dfeR","text":"Vignettes can found vignettes/ folder .Rmd files. start new one use:","code":"usethis::use_vignette(\"name_of_vignette\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"package-data","dir":"","previous_headings":"","what":"Package data","title":"Contributing to dfeR","text":"general workflow data package : Make sure everything need installed package loaded devtools::load_all() Use relevant script data-raw/ generate save data set Document data set R/datasets_documentation.R Update relevant fetch_ functions use data appropriate Run usual package checks re-documenting package update general principle data created reproducible code, ’s custom data ’re defining, write code. ’re sourcing elsewhere, try make use API connections. saves unnecessary data storage bloat makes scripts nice reproducible without external dependencies worry . try keep data-raw/ scripts tidy possible, helper functions created R/datasets-utils.R. exported users package used scripts data-raw/ folder creation data exported package. Sometimes running scripts create new data sets might hit error: , try restarting R, making sure project open, package loaded using devtools::load_all() run . details maintaining data R package generally, see chapter 7 Data, R packages Hadley Wickham Jennifer Bryan.","code":"Error in `check_is_package()`: i use_data() is designed to work with packages X Project \"some letters and numbers\" is not an R package."},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"geography-data-sets","dir":"","previous_headings":"Package data","what":"Geography data sets","title":"Contributing to dfeR","text":"package export number data sets derived ONS Open Geography portal easy reuse within DfE analysis. Whenever new data appears want make updates need manually.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"source","dir":"","previous_headings":"Package data > Geography data sets","what":"Source","title":"Contributing to dfeR","text":"can, use API get data, completely reproducible pipelines (rather saving static files manually check updates made, worry file storage). ONS Open Geography portal, usually looking data published feature feature layer, ones made available via API connection. ’ll able preview data browser basic searching / filtering table want visualise . feature data option somewhere ‘want use data’ (something similar update website design) can get API explorer allows run basic query browser. can usually find dataset_id also parameters want use get data need. get_ons_api_data() function acts wrapper ONS API, things like converting readable parameters query string also handles batching multiple requests needed, get data one nice neat data frame (’s limit rows per single query API). way ONS publish varied first years publishing, top data set individual API connection every year boundaries. ’s link time ONS side helper functions defined R/datasets_utils.R wrap single neat time series bundle us. Given likelihood variations, don’t surprised adding new years data sets results errors first time around, manual fudgery often needed roll sleeves prepare get elbow deep murky depths R/datasets_utils.R file! also data just define code curate , like custom regions publish DfE lookup table shorthands used column names ONS.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"workflow-for-updating-geography-data","dir":"","previous_headings":"Package data > Geography data sets","what":"Workflow for updating geography data","title":"Contributing to dfeR","text":"general workflow data package : Add new year relevant script data-raw/ script Run script create new data set Run package checks make sure data hasn’t gone funky Update fetch_ functions use data appropriate Document changes data set R/datasets_documentation.R appropriate data sets tests fail soon number rows columns change, provide reliable service users, also catch remind us maintain documentation row number column names defined R/datasets_documentation.R. tests fail, update relevant documentation, (!) update test expectations match new documentation. fetch_ family functions R/fetch.R act quick helpers pull data sets export, users can ees-ily grab say list Scottish Parliamentary Constituencies 2024, rather needing pull whole data frame process . Often adding new year data , need edit year variables set near start data-raw/ file also relevant fetch_ function @param year, well updating public documentation data set R/datasets_documentation.R.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to dfeR","text":"Please note dfeR project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see <http://www.gnu.org/licenses/>. GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read <http://www.gnu.org/philosophy/--lgpl.html>.","code":"<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year>  <name of author>  This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.  You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>. <program>  Copyright (C) <year>  <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":null,"dir":"","previous_headings":"","what":"Brief overview of changes","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"why-are-these-changes-being-made","dir":"","previous_headings":"","what":"Why are these changes being made?","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"detailed-description-of-changes","dir":"","previous_headings":"","what":"Detailed description of changes","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"additional-information-for-reviewers","dir":"","previous_headings":"","what":"Additional information for reviewers","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"issue-ticket-numbers-and-link","dir":"","previous_headings":"","what":"Issue ticket number/s and link","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"pre-requisites","dir":"Articles","previous_headings":"","what":"Pre-requisites","title":"Connecting to SQL","text":"connect SQL need SQL drivers installed. come standard currently Microsoft SQL Server Management Studio downloads Department Education’s software center. Make sure downloaded latest version starting.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"connecting-to-a-database","dir":"Articles","previous_headings":"","what":"Connecting to a database","title":"Connecting to SQL","text":"Usually DfE use combination odbc DBI connect SQL databases. connect vary depending whether ’re running R code laptop, part deployed R Shiny app. running code laptop can automatically use Windows login (trusted connection) grant access database, package can automatically detect user details. advice finding database details, connecting SQL database R Shiny app deployed server, please contact Statistics Development Team able advise setup steps required. Note server name may include backslashes, ’ll need make sure two backslashes R code due way special characters escaped. example, SQL Server Management Studio (SSMS) Azure Data Studio might call server T1PRANMSQL\\SQLPROD,60125, R adding server name ’d need call T1PRANMSQL\\\\SQLPROD,60125.","code":"# Library calls ====  library(odbc) library(DBI)  # Database connection ====  con <- DBI::dbConnect(odbc::odbc(),   Driver = \"ODBC Driver 17 for SQL Server\",   Server = \"server_name\",   Database = \"database_name\",   UID = \"\",   PWD = \"\",   Trusted_Connection = \"Yes\" )"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"reading-a-sql-script-into-r","dir":"Articles","previous_headings":"","what":"Reading a SQL script into R","title":"Connecting to SQL","text":"number standard characters found SQL scripts can cause issues reading SQL script within R created get_clean_sql() function assist . Assume connected database assigned connection con variable, use following line read cleaned version SQL script R. get_clean_sql() ignore lines code start USE specify database, database already specified connection setup.","code":"sql_query <- dfeR::get_clean_sql(\"path_to_sql_file.sql\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"executing-the-sql-query","dir":"Articles","previous_headings":"","what":"Executing the SQL query","title":"Connecting to SQL","text":"Now SQL query saved variable R environment can pass function execute database. ’s number potential ways , though common way use dbGetQuery() DBI package, setting statement cleaned SQL query. ’s important note dbGetQuery() intended work ‘SELECT’ style queries . ’re something isn’t ‘SELECT’ query, writing back SQL, consider using dbExecute() dbSendQuery() functions DBI package instead. side note, SQL query short, write directly function :","code":"sql_query_result <- DBI::dbGetQuery(con, statement = sql_query) sql_query_result <- DBI::dbGetQuery(   con,   statement = \"SELECT * FROM [my_database_table]\" )"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"troubleshooting","dir":"Articles","previous_headings":"Executing the SQL query","what":"Troubleshooting","title":"Connecting to SQL","text":"first advice hit error, check SQL script runs SQL Server Management Studio (SSMS) Azure Data Studio valid SQL ‘SELECT’ query returns single output. Assuming runs fine SSMS, next thing try set additional settings cleaning SQL script. can additional_settings argument get_clean_sql() function. add additional settings start SQL query sometimes necessary odbc DBI connection correctly execute query. troubleshooting tips, please see Interacting SQL database section Analysts’ Guide, contact Statistics Development Team support.","code":"sql_query <- dfeR::get_clean_sql(   \"path_to_sql_file.sql\",   additional_settings = TRUE )"},{"path":"https://dfe-analytical-services.github.io/dfeR/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Cam Race. Author, maintainer. Laura Selby. Author. Adam Robinson. Author. Jen Machin. Contributor. Jake Tufts. Contributor. Rich Bielby. Contributor. Menna Zayed. Contributor.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Race C, Selby L, Robinson (2024). dfeR: Common DfE R tasks. R package version 0.6.0, https://github.com/dfe-analytical-services/dfeR, https://dfe-analytical-services.github.io/dfeR/.","code":"@Manual{,   title = {dfeR: Common DfE R tasks},   author = {Cam Race and Laura Selby and Adam Robinson},   year = {2024},   note = {R package version 0.6.0,     https://github.com/dfe-analytical-services/dfeR},   url = {https://dfe-analytical-services.github.io/dfeR/}, }"},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"dfer-","dir":"","previous_headings":"","what":"Common DfE R tasks","title":"Common DfE R tasks","text":"goal dfeR help standardise R programming across Department Education (DfE), facilitate sharing business specific functions, making code easier read write. Credit lauraselby logo featuring Frederick!","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Common DfE R tasks","text":"package open DfE anything think useful programmers analysts can contributed. Functionality dfeR expected focus around following: DfE specific formatting helper functions Working DfE databases Templates analytical projects API wrappers commonly needed DfE analysis (don’t separate package) Geography lookup files helper functions Documentation included package far pkgdown site. also developing dfeshiny package, expect functions specific R Shiny applications live .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Common DfE R tasks","text":"dfeR currently available CRAN. time can install development version GitHub. using renv project (recommended): Otherwise:","code":"renv::install(\"dfe-analytical-services/dfeR\") # install.packages(\"devtools\") devtools::install_github(\"dfe-analytical-services/dfeR\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"proxy","dir":"","previous_headings":"","what":"Proxy","title":"Common DfE R tasks","text":"need setting proxy settings order able work R Git within DfE estate now ended. previously run proxy script previous versions dfeR package, contact Statistics Development Team assist cleaning system settings.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Common DfE R tasks","text":"Ideas dfeR first raised GitHub issue anyone free write code create pull request review. details contributing dfeR, see contributing guidelines.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Common DfE R tasks","text":"Please note dfeR project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"examples","dir":"","previous_headings":"","what":"Examples","title":"Common DfE R tasks","text":"example functions within package: details functions available package, examples use , please see dfeR package reference documentation.","code":"library(dfeR)  # Prettify large numbers pretty_num(111111111, gbp = TRUE) #> [1] \"£111.11 million\" pretty_num(-11^8, dp = -1) #> [1] \"-210 million\"  # Convert bytes to readable size pretty_filesize(77777777) #> [1] \"77.78 MB\"  # Calculate elapsed time and present prettily start <- Sys.time() end <- Sys.time() + 789890 pretty_time_taken(start, end) #> [1] \"219 hours 24 minutes 50 seconds\"  # Round 5's up instead of bankers round used by round() in base R round_five_up(2.5) #> [1] 3 round(2.5) # base R #> [1] 2  # Custom formatting for academic and financial years format_ay(202425) #> [1] \"2024/25\" format_fy(202425) #> [1] \"2024-25\" format_ay_reverse(\"2024/25\") #> [1] \"202425\" format_fy_reverse(\"2024-25\") #> [1] \"202425\"  # Get Ward to PCon to LAD to LA to Rgn to Ctry lookup file my_data <- dfeR::wd_pcon_lad_la_rgn_ctry head(my_data) # show first 5 rows in console #>   first_available_year_included most_recent_year_included #> 1                          2017                      2017 #> 2                          2017                      2017 #> 3                          2017                      2020 #> 4                          2017                      2017 #> 5                          2017                      2020 #> 6                          2017                      2017 #>                ward_name  pcon_name              lad_name               la_name #> 1               Bastwell  Blackburn Blackburn with Darwen Blackburn with Darwen #> 2                Ormesby     Redcar  Redcar and Cleveland  Redcar and Cleveland #> 3            Burn Valley Hartlepool            Hartlepool            Hartlepool #> 4 Beardwood with Lammack  Blackburn Blackburn with Darwen Blackburn with Darwen #> 5               De Bruce Hartlepool            Hartlepool            Hartlepool #> 6           St Germain's     Redcar  Redcar and Cleveland  Redcar and Cleveland #>   region_name country_name ward_code pcon_code  lad_code new_la_code #> 1  North West      England E05001621 E14000570 E06000008   E06000008 #> 2  North East      England E05001518 E14000891 E06000003   E06000003 #> 3  North East      England E05008942 E14000733 E06000001   E06000001 #> 4  North West      England E05001622 E14000570 E06000008   E06000008 #> 5  North East      England E05008943 E14000733 E06000001   E06000001 #> 6  North East      England E05001519 E14000891 E06000003   E06000003 #>   region_code country_code #> 1   E12000002    E92000001 #> 2   E12000001    E92000001 #> 3   E12000001    E92000001 #> 4   E12000002    E92000001 #> 5   E12000001    E92000001 #> 6   E12000001    E92000001  # Get all countries dfeR::countries #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown  # Get all PCon names and codes for 2024 fetch_pcons(2024) |>   head() # show first 5 rows only #>   pcon_code                pcon_name #> 1 S14000045               Midlothian #> 2 S14000027     Na h-Eileanan an Iar #> 3 S14000021        East Renfrewshire #> 4 S14000048 North Ayrshire and Arran #> 5 S14000051      Orkney and Shetland #> 6 E14001440                   Redcar  # Get All LADs in Scotland in 2017 fetch_lads(2017, \"Scotland\") |>   head() # show first 5 rows only #>    lad_code           lad_name #> 1 S12000019         Midlothian #> 2 S12000015               Fife #> 3 S12000014            Falkirk #> 4 S12000013 Na h-Eileanan Siar #> 5 S12000018         Inverclyde #> 6 S12000011  East Renfrewshire  # Get all LAs in Scotland and Northern Ireland in 2022 fetch_las(2022, c(\"Scotland\", \"Northern Ireland\")) |>   head() # show first 5 rows only #>   new_la_code                              la_name #> 1   N09000003                              Belfast #> 2   N09000004             Causeway Coast and Glens #> 3   N09000002 Armagh City, Banbridge and Craigavon #> 4   N09000005              Derry City and Strabane #> 5   N09000001              Antrim and Newtownabbey #> 6   N09000006                  Fermanagh and Omagh  # Get all Welsh wards for 2021 fetch_wards(2021, \"Wales\") |>   head() # show first 5 rows only #>   ward_code                   ward_name #> 1 W05000981                      Aethwy #> 2 W05000982               Bro Aberffraw #> 3 W05000983                  Bro Rhosyr #> 4 W05000107 Tregarth & Mynydd Llandygai #> 5 W05000984                    Caergybi #> 6 W05000985              Canolbarth Môn  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown  fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Validation for fetch location lookups — check_fetch_location_inputs","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"Validation fetch location lookups","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"","code":"check_fetch_location_inputs(year_input, country_input)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"year_input value years input country_input value countries input","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"nothing, unless failure, give error","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":null,"dir":"Reference","previous_headings":"","what":"Comma separate — comma_sep","title":"Comma separate — comma_sep","text":"Adds separating commas big numbers. value numeric return value unchanged string.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Comma separate — comma_sep","text":"","code":"comma_sep(number, nsmall = 0L)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Comma separate — comma_sep","text":"number number comma separated nsmall minimum number digits right decimal point","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Comma separate — comma_sep","text":"string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Comma separate — comma_sep","text":"","code":"comma_sep(100) #> [1] \"100\" comma_sep(1000) #> [1] \"1,000\" comma_sep(3567000) #> [1] \"3,567,000\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for valid country names and codes — countries","title":"Lookup for valid country names and codes — countries","text":"lookup ONS geography country names codes, well custom DfE names codes. used definitive list screening open data published DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for valid country names and codes — countries","text":"","code":"countries"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"countries","dir":"Reference","previous_headings":"","what":"countries","title":"Lookup for valid country names and codes — countries","text":"data frame 10 rows 2 columns: country_name Country name country_code Country code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for valid country names and codes — countries","text":"curated explore.statistics@education.gov.uk, ONS codes sourced https://geoportal.statistics.gov.uk/search?q=countries%20names%20and%20codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates a pre-populated project for DfE R — create_project","title":"Creates a pre-populated project for DfE R — create_project","text":"Creates pre-populated project DfE R","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates a pre-populated project for DfE R — create_project","text":"","code":"create_project(   path,   init_renv = TRUE,   include_structure_for_pkg = FALSE,   create_publication_proj = FALSE,   include_github_gitignore,   ... )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates a pre-populated project for DfE R — create_project","text":"path Path new project init_renv Boolean; initiate renv project. Default set true. include_structure_for_pkg Boolean; Additional folder structure package development. Default set false. create_publication_proj Boolean; folder structure publication project. Default set false. include_github_gitignore Boolean; strict .gitignore file GitHub created. ... Additional parameters, currently used","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates a pre-populated project for DfE R — create_project","text":"return values, project contents created","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Creates a pre-populated project for DfE R — create_project","text":"function creates new project custom folder structure. sets R/ folder template function scripts, initializes {testthat} adds tests function scripts, builds core project structure, creates .gitignore file, creates readme, optionally initializes {renv}.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates a pre-populated project for DfE R — create_project","text":"","code":"if (FALSE) { # \\dontrun{  # Call the function to create a new project dfeR::create_project(   path = \"C:/path/to/your/new/project\",   init_renv = TRUE,   include_structure_for_pkg = FALSE,   create_publication_proj = FALSE,   include_github_gitignore = TRUE ) } # }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":null,"dir":"Reference","previous_headings":"","what":"Smush lookups together to make a time series — create_time_series_lookup","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"Take list tidied files, likely produced tidy_raw_lookup function append together","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"","code":"create_time_series_lookup(lookups_list)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"lookups_list list data frames new lookup table, usually output tidy_raw_lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"single data.frame lookup files combined","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"Updates first_available_year_included most_recent_year_included columns accurate full ser-EES","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/dfeR-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dfeR: Common DfE R tasks — dfeR-package","title":"dfeR: Common DfE R tasks — dfeR-package","text":"package contains R functions allow DfE analysts re-use code common analytical tasks undertaken across Department.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/dfeR-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dfeR: Common DfE R tasks — dfeR-package","text":"Maintainer: Cam Race cameron.race@education.gov.uk Authors: Laura Selby laura.selby@education.gov.uk Adam Robinson contributors: Jen Machin jen.machin@education.gov.uk [contributor] Jake Tufts jake.tufts@education.gov.uk [contributor] Rich Bielby richard.bielby@education.gov.uk (ORCID) [contributor] Menna Zayed menna.zayed@education.gov.uk [contributor]","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Westminster parliamentary constituencies — fetch","title":"Fetch Westminster parliamentary constituencies — fetch","text":"Fetch data frame Westminster Parliamentary Constituencies given year country based dfeR::wd_pcon_lad_la_rgn_ctry file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Westminster parliamentary constituencies — fetch","text":"","code":"fetch_pcons(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Westminster parliamentary constituencies — fetch","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Westminster parliamentary constituencies — fetch","text":"data frame unique location names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Westminster parliamentary constituencies — fetch","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch countries — fetch_countries","title":"Fetch countries — fetch_countries","text":"Fetch countries","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch countries — fetch_countries","text":"","code":"fetch_countries()"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch countries — fetch_countries","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch countries — fetch_countries","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch local authority districts — fetch_lads","title":"Fetch local authority districts — fetch_lads","text":"Fetch local authority districts","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch local authority districts — fetch_lads","text":"","code":"fetch_lads(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch local authority districts — fetch_lads","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch local authority districts — fetch_lads","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch local authority districts — fetch_lads","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch local authorities — fetch_las","title":"Fetch local authorities — fetch_las","text":"Fetch local authorities","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch local authorities — fetch_las","text":"","code":"fetch_las(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch local authorities — fetch_las","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch local authorities — fetch_las","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch local authorities — fetch_las","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch locations for a given lookup — fetch_locations","title":"Fetch locations for a given lookup — fetch_locations","text":"Helper function fetch_xxx() functions save repeating code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch locations for a given lookup — fetch_locations","text":"","code":"fetch_locations(lookup_data, cols, year, countries)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch locations for a given lookup — fetch_locations","text":"lookup_data lookup data use extract locations cols columns extract main lookup table year year locations extract, \"\" skip filtering return possible locations countries countries locations take , \"\" skip filtering return ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch locations for a given lookup — fetch_locations","text":"data frame location names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch regions — fetch_regions","title":"Fetch regions — fetch_regions","text":"Fetch regions","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch regions — fetch_regions","text":"","code":"fetch_regions()"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch regions — fetch_regions","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch regions — fetch_regions","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch wards — fetch_wards","title":"Fetch wards — fetch_wards","text":"Fetch wards","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch wards — fetch_wards","text":"","code":"fetch_wards(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch wards — fetch_wards","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch wards — fetch_wards","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch wards — fetch_wards","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":null,"dir":"Reference","previous_headings":"","what":"Format academic year — format_ay","title":"Format academic year — format_ay","text":"function formats academic year variables reporting purposes. convert academic year input 201516 format 2015/16 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format academic year — format_ay","text":"","code":"format_ay(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format academic year — format_ay","text":"year Academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format academic year — format_ay","text":"Character vector formatted academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format academic year — format_ay","text":"accepts numerical character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format academic year — format_ay","text":"","code":"format_ay(201617) #> [1] \"2016/17\" format_ay(\"201617\") #> [1] \"2016/17\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":null,"dir":"Reference","previous_headings":"","what":"Undo academic year formatting — format_ay_reverse","title":"Undo academic year formatting — format_ay_reverse","text":"function converts academic year variables back 201617 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Undo academic year formatting — format_ay_reverse","text":"","code":"format_ay_reverse(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Undo academic year formatting — format_ay_reverse","text":"year Academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Undo academic year formatting — format_ay_reverse","text":"Unformatted 6 digit year string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Undo academic year formatting — format_ay_reverse","text":"accepts character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Undo academic year formatting — format_ay_reverse","text":"","code":"format_ay_reverse(\"2016/17\") #> [1] \"201617\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":null,"dir":"Reference","previous_headings":"","what":"Format financial year — format_fy","title":"Format financial year — format_fy","text":"function formats financial year variables reporting purposes. convert year input 201516 format 2015-16 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format financial year — format_fy","text":"","code":"format_fy(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format financial year — format_fy","text":"year Financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format financial year — format_fy","text":"Character vector formatted financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format financial year — format_fy","text":"accepts numerical character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format financial year — format_fy","text":"","code":"format_fy(201617) #> [1] \"2016-17\" format_fy(\"201617\") #> [1] \"2016-17\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":null,"dir":"Reference","previous_headings":"","what":"Undo financial year formatting — format_fy_reverse","title":"Undo financial year formatting — format_fy_reverse","text":"function converts financial year variables back 201617 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Undo financial year formatting — format_fy_reverse","text":"","code":"format_fy_reverse(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Undo financial year formatting — format_fy_reverse","text":"year Financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Undo financial year formatting — format_fy_reverse","text":"Unformatted 6 digit year string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Undo financial year formatting — format_fy_reverse","text":"accepts character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Undo financial year formatting — format_fy_reverse","text":"","code":"format_fy_reverse(\"2016-17\") #> [1] \"201617\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a cleaned SQL script into R — get_clean_sql","title":"Get a cleaned SQL script into R — get_clean_sql","text":"function cleans SQL script, ready using within R DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a cleaned SQL script into R — get_clean_sql","text":"","code":"get_clean_sql(filepath, additional_settings = FALSE)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a cleaned SQL script into R — get_clean_sql","text":"filepath path SQL script additional_settings TRUE FALSE boolean addition settings start SQL script","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a cleaned SQL script into R — get_clean_sql","text":"Cleaned string containing SQL query","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a cleaned SQL script into R — get_clean_sql","text":"","code":"# This assumes you have already set up a database connection # and that the filepath for the function exists # For more details see the vignette on connecting to SQL  # Pull a cleaned version of the SQL file into R if (file.exists(\"your_script.sql\")) {   sql_query <- get_clean_sql(\"your_script.sql\") }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":null,"dir":"Reference","previous_headings":"","what":"Get LAD to Region lookup — get_lad_region","title":"Get LAD to Region lookup — get_lad_region","text":"Helper function extract data Ward-LAD-Region-County-Country file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get LAD to Region lookup — get_lad_region","text":"","code":"get_lad_region(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get LAD to Region lookup — get_lad_region","text":"year last two digits year lookup, available years : 2017, 2018, 2019, 2020, 2022, 2023","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get LAD to Region lookup — get_lad_region","text":"data.frame individual year lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch ONS Open Geography API data — get_ons_api_data","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"Helper function takes data set id parameters query parse data ONS Open Geography API. Technically uses POST request rather GET request.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"","code":"get_ons_api_data(   data_id,   query_params = list(where = \"1=1\", outFields = \"*\", outSR = \"4326\", f = \"json\"),   batch_size = 200,   verbose = TRUE )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"data_id id data set query, can found Open Geography Portal query_params query parameters pass API, see ESRI documentation information query parameters - ESRI Query (Feature Service/Layer) batch_size number rows per query. 250 default, hit errors try lowering . API limit 1000 2000 rows per query, truth, actual limit method lower every ObjectId queried pasted query URL every row included batch, especial Id's go 1,000s 10,000s increase size URL risk hitting limit. verbose TRUE FALSE boolean. TRUE default. FALSE turn messages console update function ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"parsed data.frame geographic names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"pre-query understand ObjectIds query want, query retrieve Ids directly batches stacking whole thing back together work around row limits single query. Open Geography Portal, find data set interested use query explorer find information query.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"","code":"if (interactive()) {   # Specify some parameters   get_ons_api_data(     data_id = \"LAD23_RGN23_EN_LU\",     query_params =       list(outFields = \"column1, column2\", outSR = \"4326\", f = \"json\")   )    # Just fetch everything   get_ons_api_data(data_id = \"LAD23_RGN23_EN_LU\") }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"Helper function extract data Ward-PCon-LAD-UTLA file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"","code":"get_wd_pcon_lad_la(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"year last two digits year lookup, available years : 2017, 2019, 2020, 2021, 2022, 2023, 2024","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"data.frame individual year lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"lookup ONS geography shorthands respective column names line DfE open data standards.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"","code":"ons_geog_shorthands"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"ons-geog-shorthands","dir":"Reference","previous_headings":"","what":"ons_geog_shorthands","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"data frame 7 rows 3 columns: ons_level_shorthands ONS shorthands used lookup files name_column DfE names geography name columns code_column DfE names geography code columns","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"curated explore.statistics@education.gov.uk","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"GOR (Government Office Region) predecessor RGN.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":null,"dir":"Reference","previous_headings":"","what":"Pretty numbers into readable file size — pretty_filesize","title":"Pretty numbers into readable file size — pretty_filesize","text":"Converts raw file size bytes readable format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pretty numbers into readable file size — pretty_filesize","text":"","code":"pretty_filesize(filesize)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pretty numbers into readable file size — pretty_filesize","text":"filesize file size bytes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pretty numbers into readable file size — pretty_filesize","text":"string containing prettified file size","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Pretty numbers into readable file size — pretty_filesize","text":"Designed used conjunction file.size() function base R. Presents kilobytes, megabytes gigabytes. Shows bytes 1 KB, kilobytes 1 MB, megabytes 1GB, show gigabytes anything larger. Rounds end result 2 decimal places. Using base 10 (decimal), 1024 bytes 1,024 KB.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pretty numbers into readable file size — pretty_filesize","text":"","code":"pretty_filesize(2) #> [1] \"2 bytes\" pretty_filesize(549302) #> [1] \"549.3 KB\" pretty_filesize(9872948939) #> [1] \"9.87 GB\" pretty_filesize(1) #> [1] \"1 byte\" pretty_filesize(1000) #> [1] \"1 KB\" pretty_filesize(1000^2) #> [1] \"1 MB\" pretty_filesize(10^9) #> [1] \"1 GB\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":null,"dir":"Reference","previous_headings":"","what":"Prettify big numbers into a readable format — pretty_num","title":"Prettify big numbers into a readable format — pretty_num","text":"Uses .numeric() force numeric value formats prettily easy presentation console messages, reports, dashboards. rounds 2 decimal places default, adds comma separators. Expect commonly used adding pound symbol, percentage symbol, +/- prefixed based value. applying multiple unpredictable values want preserve non-numeric symbol \"x\" \"c\" data available, use ignore_na = TRUE argument return values unaffected. want customise NA values returned , use alt_na argument. function silences warning around NAs introduced coercion.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prettify big numbers into a readable format — pretty_num","text":"","code":"pretty_num(   value,   prefix = \"\",   gbp = FALSE,   suffix = \"\",   dp = 2,   ignore_na = FALSE,   alt_na = FALSE,   nsmall = NULL )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prettify big numbers into a readable format — pretty_num","text":"value value prettified prefix prefix value, \"+/-\" automatically assign + - based value gbp whether add pound symbol , defaults suffix suffix value, e.g. \"%\" dp number decimal places round , 2 default ignore_na whether skip function strings converted return original value alt_na alternative value return place NA, e.g. \"x\" nsmall minimum number digits right decimal point","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prettify big numbers into a readable format — pretty_num","text":"string featuring prettified value","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prettify big numbers into a readable format — pretty_num","text":"","code":"# On individual values pretty_num(5789, gbp = TRUE) #> [1] \"£5,789.00\" pretty_num(564, prefix = \"+/-\") #> [1] \"+564.00\" pretty_num(567812343223, gbp = TRUE, prefix = \"+/-\") #> [1] \"+£567.81 billion\" pretty_num(11^9, gbp = TRUE, dp = 3) #> [1] \"£2.358 billion\" pretty_num(-11^8, gbp = TRUE, dp = -1) #> [1] \"-£210 million\" pretty_num(43.3, dp = 1, nsmall = 2) #> [1] \"43.30\" pretty_num(\"56.089\", suffix = \"%\") #> [1] \"56.09%\" pretty_num(\"x\") #> [1] NA pretty_num(\"x\", ignore_na = TRUE) #> [1] \"x\" pretty_num(\"nope\", alt_na = \"x\") #> [1] \"x\"  # Applied over an example vector vector <- c(3998098008, -123421421, \"c\", \"x\") pretty_num(vector) #> [1] \"4.00 billion\"    \"-123.42 million\" NA                NA                pretty_num(vector, prefix = \"+/-\", gbp = TRUE) #> [1] \"+£4.00 billion\"   \"-£123.42 million\" NA                 NA                  # Return original values if NA pretty_num(vector, ignore_na = TRUE) #> [1] \"4.00 billion\"    \"-123.42 million\" \"c\"               \"x\"                # Return alternative value in place of NA pretty_num(vector, alt_na = \"z\") #> [1] \"4.00 billion\"    \"-123.42 million\" \"z\"               \"z\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"can format number character values data frame passing arguments dfeR::pretty_num(). Use parameters include_columns exclude_columns specify columns formatting.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"","code":"pretty_num_table(data, include_columns = NULL, exclude_columns = NULL, ...)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"data data frame containing columns formatted. include_columns character vector specifying columns format. NULL (default), columns considered formatting. exclude_columns character vector specifying columns exclude formatting. NULL (default), columns excluded. include_columns exclude_columns provided , include_columns takes precedence. ... Additional arguments passed dfeR::pretty_num() , dp (decimal places) controlling number decimal points.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"data frame columns formatted using dfeR::pretty_num().","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"function first checks columns specified inclusion via include_columns. none provided, checks columns specified exclusion via exclude_columns. neither specified, columns data frame formatted.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"","code":"# Example data frame df <- data.frame(   a = c(1.234, 5.678, 9.1011),   b = c(10.1112, 20.1314, 30.1516),   c = c(\"A\", \"B\", \"C\") )  # Apply formatting to all columns pretty_num_table(df, dp = 2) #>      a     b  c #> 1 1.23 10.11 NA #> 2 5.68 20.13 NA #> 3 9.10 30.15 NA  # Apply formatting to only selected columns pretty_num_table(df, include_columns = c(\"a\"), dp = 2) #>      a       b c #> 1 1.23 10.1112 A #> 2 5.68 20.1314 B #> 3 9.10 30.1516 C  # Apply formatting to all columns except specified ones pretty_num_table(df, exclude_columns = c(\"b\"), dp = 2) #>      a       b  c #> 1 1.23 10.1112 NA #> 2 5.68 20.1314 NA #> 3 9.10 30.1516 NA  # Apply formatting to all columns except specified ones and # provide alternative value for NAs pretty_num_table(df, alt_na = \"[z]\", exclude_columns = c(\"b\"), dp = 2) #>      a       b   c #> 1 1.23 10.1112 [z] #> 2 5.68 20.1314 [z] #> 3 9.10 30.1516 [z]"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate elapsed time between two points and present prettily — pretty_time_taken","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"Converts start end value readable time format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"","code":"pretty_time_taken(start_time, end_time)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"start_time start time readable .POSIXct end_time end time readable .POSIXct","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"string containing prettified elapsed time","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"Designed used Sys.time() tracking start end times. Shows seconds 119 seconds, minutes 119 minutes, hours anything larger. Input start end times must convertible POSIXct format.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"","code":"pretty_time_taken(   \"2024-03-23 07:05:53 GMT\",   \"2024-03-23 12:09:56 GMT\" ) #> [1] \"5 hours 4 minutes 3 seconds\"  # Track the start and end time of a process start <- Sys.time() Sys.sleep(0.1) end <- Sys.time()  # Use this function to present it prettily pretty_time_taken(start, end) #> [1] \"0.1 seconds\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for valid region names and codes — regions","title":"Lookup for valid region names and codes — regions","text":"lookup ONS geography region names codes England. lookups Northern Ireland, Scotland Wales regions.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for valid region names and codes — regions","text":"","code":"regions"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"regions","dir":"Reference","previous_headings":"","what":"regions","title":"Lookup for valid region names and codes — regions","text":"data frame 16 rows 2 columns: region_name Region name region_code Region code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for valid region names and codes — regions","text":"curated explore.statistics@education.gov.uk, ONS codes sourced https://geoportal.statistics.gov.uk/search?q=NAC_RGN","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lookup for valid region names and codes — regions","text":"Also included inner outer London county split DfE frequently publish regions, well custom DfE names codes. used definitive list screening open data published DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":null,"dir":"Reference","previous_headings":"","what":"Round five up — round_five_up","title":"Round five up — round_five_up","text":"Round number specified number places, 5's rounded .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round five up — round_five_up","text":"","code":"round_five_up(number, dp = 0)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round five up — round_five_up","text":"number number rounded dp number decimal places round , default 0","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round five up — round_five_up","text":"Rounded number","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Round five up — round_five_up","text":"Rounds 0 decimal places default. can use negative value decimal places. example: -1 round nearest 10 -2 round nearest 100 . alternative round base R, uses bankers round. information see round() documentation.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Round five up — round_five_up","text":"","code":"# No dp set round_five_up(2485.85) #> [1] 2486  # With dp set round_five_up(2485.85, 2) #> [1] 2485.85 round_five_up(2485.85, 1) #> [1] 2485.9 round_five_up(2485.85, 0) #> [1] 2486 round_five_up(2485.85, -1) #> [1] 2490 round_five_up(2485.85, -2) #> [1] 2500"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":null,"dir":"Reference","previous_headings":"","what":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"Takes file open geography portal tidies ready appending existing lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"","code":"tidy_raw_lookup(raw_lookup_file)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"raw_lookup_file data.frame lookup file downloaded Open Geography Portal, e.g. output get_ons_api_data(), data frame R memory","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"data frame tidied lookup file Function rename columns using dfeR::ons_geog_shorthands table col_name single column name updated based shorthand lookup table string new column name match found, match found original name returned","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":null,"dir":"Reference","previous_headings":"","what":"Controllable console messages — toggle_message","title":"Controllable console messages — toggle_message","text":"Quick expansion message() function aimed use functions easy addition global verbose TRUE / FALSE argument toggle messages ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Controllable console messages — toggle_message","text":"","code":"toggle_message(..., verbose)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Controllable console messages — toggle_message","text":"... message normally pass message(). See message details verbose logical, usually variable passed function using within","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Controllable console messages — toggle_message","text":"","code":"# Usually used in a function my_function <- function(count_fingers, verbose) {   toggle_message(\"I have \", count_fingers, \" fingers\", verbose = verbose)   fingers_thumbs <- count_fingers + 2   toggle_message(\"I have \", fingers_thumbs, \" digits\", verbose = verbose) }  my_function(5, verbose = FALSE) my_function(5, verbose = TRUE) #> I have 5 fingers #> I have 7 digits  # Can be used in isolation toggle_message(\"I want the world to read this!\", verbose = TRUE) #> I want the world to read this! toggle_message(\"I ain't gonna show this message!\", verbose = FALSE)  count_fingers <- 5 toggle_message(\"I have \", count_fingers, \" fingers\", verbose = TRUE) #> I have 5 fingers"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":null,"dir":"Reference","previous_headings":"","what":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"lookup showing hierarchy ward Westminster parliamentary constituency local authority district local authority region country years 2017, 2019, 2020, 2021, 2022, 2023 2024.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"","code":"wd_pcon_lad_la_rgn_ctry"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"wd-pcon-lad-la-rgn-ctry","dir":"Reference","previous_headings":"","what":"wd_pcon_lad_la_rgn_ctry","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"data frame 24,629 rows 14 columns: first_available_year_included First year lookups see location most_recent_year_included Last year lookups see location ward_name Ward name pcon_name Parliamentary constituency name lad_name Local authority district name la_name Local authority name region_name Region name country_code Country name ward_code 9 digit ward code pcon_code 9 digit westminster constituency code lad_code 9 digit local authority district code new_la_code 9 digit local authority code region_code 9 digit region code country_code 9 digit country code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"https://geoportal.statistics.gov.uk/search?tags=lup_wd_pcon_lad_utla https://geoportal.statistics.gov.uk/search?q=lup_wd_lad_cty_rgn_gor_ctry","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"Changes made original lookup: original lookup ONS uses Upper Tier Local Authority, update metropolitan local authority use local authority district local authority match DfE publish data local authorities. noticed 2017 version, Glasgow East constituency code S1400030 instead usual S14000030, assumed error change data Glasgow East S14000030 2017. joined regions using Ward LAD County Region file. joined countries based E / N / S / W start codes. Scotland published regions 2017, given rest years Scotland region, forced 2017 complete data set.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-060","dir":"Changelog","previous_headings":"","what":"dfeR 0.6.0","title":"dfeR 0.6.0","text":"Update pretty_num : can take single multiple values. argument nsmall allows control number digits displayed rounding. Add pretty_num_table() uses pretty_num() format numbers readable format data frames. customization provided pretty_num.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-051","dir":"Changelog","previous_headings":"","what":"dfeR 0.5.1","title":"dfeR 0.5.1","text":"Patch update get_clean_sql() function ignore lines starting ‘USE’.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-050","dir":"Changelog","previous_headings":"","what":"dfeR 0.5.0","title":"dfeR 0.5.0","text":"Add following lookup data sets package: ons_geog_shorthands countries regions wd_pcon_lad_la_rgn_ctry Add following fetch_locations() functions: fetch_wards() fetch_pcons() fetch_lads() fetch_las() fetch_regions() fetch_countries() Add wrapper ONS Open Geography Portal API: get_ons_api_data() Add helper turning messages : toggle_message()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-041","dir":"Changelog","previous_headings":"","what":"dfeR 0.4.1","title":"dfeR 0.4.1","text":"Update comma_sep() function allow non-numeric values instead throwing error, now returns unchanged.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-040","dir":"Changelog","previous_headings":"","what":"dfeR 0.4.0","title":"dfeR 0.4.0","text":"Add function creates DfE R project: create_project()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-031","dir":"Changelog","previous_headings":"","what":"dfeR 0.3.1","title":"dfeR 0.3.1","text":"Fix bug get_clean_sql() using additional settings lose original SQL statement.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-030","dir":"Changelog","previous_headings":"","what":"dfeR 0.3.0","title":"dfeR 0.3.0","text":"Add pretty_* functions presenting pretty numbers: pretty_num() pretty_filesize() pretty_time_taken() Add helper function comma separating numbers: comma_sep()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-020","dir":"Changelog","previous_headings":"","what":"dfeR 0.2.0","title":"dfeR 0.2.0","text":"Add function formatting financial years: format_fy() Add reversing functions academic financial years: format_ay_reverse() format_fy_reverse() Add function grabbing cleaning SQL script, vignette connecting SQL. get_clean_sql()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-011","dir":"Changelog","previous_headings":"","what":"dfeR 0.1.1","title":"dfeR 0.1.1","text":"Add default value decimal place argument round_five_up() function.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-010","dir":"Changelog","previous_headings":"","what":"dfeR 0.1.0","title":"dfeR 0.1.0","text":"Relaunch package two functions: format_ay() round_five_up()","code":""}]
+[{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement statistics.development@education.gov.uk. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to dfeR","title":"Contributing to dfeR","text":"Ideas dfeR first raised GitHub issue anyone free write code create pull request review. detailed discussion contributing R packages tidyverse, please see development contributing guide code review principles. Full knowledge isn’t needed, though awareness general principles may useful.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"support","dir":"","previous_headings":"","what":"Support","title":"Contributing to dfeR","text":"’re keen anyone DfE able feel comfortable contributing package. questions, like support making changes, let Statistics Development Team know.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"basics","dir":"","previous_headings":"","what":"Basics","title":"Contributing to dfeR","text":"contributing dfeR work new branch taken main. pull request must reviewed approved least one admin user can merged. ’ve found bug, please file issue illustrates bug minimal reprex example (also help write unit test, needed). See tidyverse guide create great issue advice.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"Basics","what":"Fixing typos","title":"Contributing to dfeR","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"Basics","what":"Bigger changes","title":"Contributing to dfeR","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees change. Packages worth installing aid development : possible, ’d recommend following Test Driven Development (TDD) approach. Though ’re new package development, already code specific function feel free start step 2, copy function package go back step 1 afterwards. Write tests using testthat behaviour want. Either edit existing test script, adding new function, create test script using: Feel free look /tests/test_that folder examples want see example tests practice. Write just enough code tests pass. , either edit existing function, add new R script using: Add documentation ’ve done. Follow roxygen2 pattern comments. can add standard skeleton using Code > Insert Roxygen Skeleton Ctrl+Shift+Alt+R R script. ’s example looks like basic add() function: Continue improve code keeping tests passing. Automatically style code using: Run full check package using following functions:","code":"install.packages(\"devtools\") install.packages(\"usethis\") install.packages(\"pkgdown\") install.packages(\"roxygen2\") install.packages(\"spelling\") install.packages(\"lintr\") install.packages(\"styler\") usethis::use_test(\"name_of_new_function\") usethis::use_r(\"name_of_new_function\") #' @description Add together two numbers #' #' @param x A number. #' @param y A number. #' @return A number. #' @examples #' add(1, 1) #' add(10, 1) add <- function(x, y) {   x + y } styler::style_pkg() devtools::check() # General package check, can also use Ctrl-Shift-E lintr::lint_package() # Check formatting of code spelling::spell_check() # Check for spelling mistakes"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"handy-workflows","dir":"","previous_headings":"","what":"Handy workflows","title":"Contributing to dfeR","text":"Keyboard shortcuts devtools package use RStudio: recommend using usethis package possible consistency simplicity.","code":"load_all() # (Ctrl-Shift-L): Load code with dfeR package test() # (Ctrl-Shift-T): Run tests document() # (Ctrl-Shift-D): Rebuild docs and NAMESPACE check() # (Ctrl-Shift-E): Check complete package"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"adding-package-dependencies","dir":"","previous_headings":"","what":"Adding package dependencies","title":"Contributing to dfeR","text":"Add packages package users need : Add packages package developers may need :","code":"usethis::use_package(pkgname) usethis::use_package(pkgname, type = \"suggests\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"updating-the-readme","dir":"","previous_headings":"","what":"Updating the README","title":"Contributing to dfeR","text":"two README files linked pre-commit-hook ensure kept sync. Make changes README.Rmd file run following line rebuild:","code":"devtools::build_readme()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"pkgdown-site","dir":"","previous_headings":"","what":"pkgdown site","title":"Contributing to dfeR","text":"pkgdown site automatically generated. theme set _pkgdown.yml file. Custom CSS can set pkgdown/extra.css file. make edits file need re-initialise site using following line: site hosted GitHub pages. build preview pkgdown site locally running:","code":"pkgdown::init_site() devtools::build_site()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"updating-the-package-version","dir":"","previous_headings":"","what":"Updating the package version","title":"Contributing to dfeR","text":"changes completed, reviewed ready use wild, can increment package version using: unsure kind version increment, look lifecycle’s guidance release types. ’ve incremented version number, ’ll offer perform commit behalf. happens add update NEWS.md, acts changelog package. Make sure updated correctly push GitHub. version updated pushed, create new GitHub release version.","code":"usethis::use_version()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"lifecyles","dir":"","previous_headings":"Updating the package version","what":"Lifecyles","title":"Contributing to dfeR","text":"package lifecycle imported, follow guidance process around deprecating functions arguments.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"","what":"Code style","title":"Contributing to dfeR","text":"New code follow tidyverse style guide. use lintr scan styling pull requests, automatically run add comments code failing standards ’d expect. happen, please proactively resolve unlikely approve pull requests styling issues. can use styler package apply styling using: check styling issues locally, use: styler fix linting issues, recommend using first, using lintr check places may need manually fix styling issues line length using snake_case.","code":"styler::style_pkg() lintr::lint_package()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"folder-and-script-structure-conventions","dir":"","previous_headings":"","what":"Folder and script structure conventions","title":"Contributing to dfeR","text":"R package allowed sub directories R/ folder. possible : one script per function one script per function family function belongs family script share name function family. needed _utils.R script used internal functions relate specific family. Documentation data shipped packages kept R/datasets_documentation.R. Scripts used preparing data used package R folder, data-raw/ folder, helper functions can found R/datasets_utils.R folder, details maintaining data sets can found Package data header page. utils.R used hold cross-package helpers aren’t exported functions specific family. Every exported function data set gets test script, called test-<function-name>.R test-data-<data-name>.R data set.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"testing","dir":"","previous_headings":"Folder and script structure conventions","what":"Testing","title":"Contributing to dfeR","text":"use testthat unit tests, expect new functions level test coverage. want see examples existing tests inspiration, take look inside tests/testthat/ folder.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"test-coverage","dir":"","previous_headings":"Folder and script structure conventions","what":"Test coverage","title":"Contributing to dfeR","text":"GitHub Actions workflows check link package codecov.io, runs automatic scans check % lines functions testing. dfeR codecov pages can preview variation branch commit see impact changes made. need create account login using GitHub see pages. current % coverage shown badge package README GitHub. worth noting 100% coverage mean tests perfect, means lines ran tests, ’s measure quantity rather quality. Interesting see though, ’d recommend using spot potential elements complicated functions may forgotten test.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"spelling","dir":"","previous_headings":"Folder and script structure conventions","what":"Spelling","title":"Contributing to dfeR","text":"spelling package used check spelling. custom word list exceptions package exists inst/ folder. messages devtools::check() output ’s potential spelling errors. Please review fix genuine errors. can run check using: automatically pick genuine new words package add list, use:","code":"spelling::spell_check_package() spelling::update_wordlist()"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"adding-vignettes","dir":"","previous_headings":"","what":"Adding vignettes","title":"Contributing to dfeR","text":"Vignettes can found vignettes/ folder .Rmd files. start new one use:","code":"usethis::use_vignette(\"name_of_vignette\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"package-data","dir":"","previous_headings":"","what":"Package data","title":"Contributing to dfeR","text":"general workflow data package : Make sure everything need installed package loaded devtools::load_all() Use relevant script data-raw/ generate save data set Document data set R/datasets_documentation.R Update relevant fetch_ functions use data appropriate Run usual package checks re-documenting package update general principle data created reproducible code, ’s custom data ’re defining, write code. ’re sourcing elsewhere, try make use API connections. saves unnecessary data storage bloat makes scripts nice reproducible without external dependencies worry . try keep data-raw/ scripts tidy possible, helper functions created R/datasets-utils.R. exported users package used scripts data-raw/ folder creation data exported package. Sometimes running scripts create new data sets might hit error: , try restarting R, making sure project open, package loaded using devtools::load_all() run . details maintaining data R package generally, see chapter 7 Data, R packages Hadley Wickham Jennifer Bryan.","code":"Error in `check_is_package()`: i use_data() is designed to work with packages X Project \"some letters and numbers\" is not an R package."},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"geography-data-sets","dir":"","previous_headings":"Package data","what":"Geography data sets","title":"Contributing to dfeR","text":"package export number data sets derived ONS Open Geography portal easy reuse within DfE analysis. Whenever new data appears want make updates need manually.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"source","dir":"","previous_headings":"Package data > Geography data sets","what":"Source","title":"Contributing to dfeR","text":"can, use API get data, completely reproducible pipelines (rather saving static files manually check updates made, worry file storage). ONS Open Geography portal, usually looking data published feature feature layer, ones made available via API connection. ’ll able preview data browser basic searching / filtering table want visualise . feature data option somewhere ‘want use data’ (something similar update website design) can get API explorer allows run basic query browser. can usually find dataset_id also parameters want use get data need. get_ons_api_data() function acts wrapper ONS API, things like converting readable parameters query string also handles batching multiple requests needed, get data one nice neat data frame (’s limit rows per single query API). way ONS publish varied first years publishing, top data set individual API connection every year boundaries. ’s link time ONS side helper functions defined R/datasets_utils.R wrap single neat time series bundle us. Given likelihood variations, don’t surprised adding new years data sets results errors first time around, manual fudgery often needed roll sleeves prepare get elbow deep murky depths R/datasets_utils.R file! also data just define code curate , like custom regions publish DfE lookup table shorthands used column names ONS.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"workflow-for-updating-geography-data","dir":"","previous_headings":"Package data > Geography data sets","what":"Workflow for updating geography data","title":"Contributing to dfeR","text":"general workflow data package : Add new year relevant script data-raw/ script Run script create new data set Run package checks make sure data hasn’t gone funky Update fetch_ functions use data appropriate Document changes data set R/datasets_documentation.R appropriate data sets tests fail soon number rows columns change, provide reliable service users, also catch remind us maintain documentation row number column names defined R/datasets_documentation.R. tests fail, update relevant documentation, (!) update test expectations match new documentation. fetch_ family functions R/fetch.R act quick helpers pull data sets export, users can ees-ily grab say list Scottish Parliamentary Constituencies 2024, rather needing pull whole data frame process . Often adding new year data , need edit year variables set near start data-raw/ file also relevant fetch_ function @param year, well updating public documentation data set R/datasets_documentation.R.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to dfeR","text":"Please note dfeR project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see <http://www.gnu.org/licenses/>. GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read <http://www.gnu.org/philosophy/--lgpl.html>.","code":"<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year>  <name of author>  This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.  You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>. <program>  Copyright (C) <year>  <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":null,"dir":"","previous_headings":"","what":"Brief overview of changes","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"why-are-these-changes-being-made","dir":"","previous_headings":"","what":"Why are these changes being made?","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"detailed-description-of-changes","dir":"","previous_headings":"","what":"Detailed description of changes","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"additional-information-for-reviewers","dir":"","previous_headings":"","what":"Additional information for reviewers","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/PULL_REQUEST_TEMPLATE.html","id":"issue-ticket-numbers-and-link","dir":"","previous_headings":"","what":"Issue ticket number/s and link","title":"Brief overview of changes","text":"…","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"pre-requisites","dir":"Articles","previous_headings":"","what":"Pre-requisites","title":"Connecting to SQL","text":"connect SQL need SQL drivers installed. come standard currently Microsoft SQL Server Management Studio downloads Department Education’s software center. Make sure downloaded latest version starting.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"connecting-to-a-database","dir":"Articles","previous_headings":"","what":"Connecting to a database","title":"Connecting to SQL","text":"Usually DfE use combination odbc DBI connect SQL databases. connect vary depending whether ’re running R code laptop, part deployed R Shiny app. running code laptop can automatically use Windows login (trusted connection) grant access database, package can automatically detect user details. advice finding database details, connecting SQL database R Shiny app deployed server, please contact Statistics Development Team able advise setup steps required. Note server name may include backslashes, ’ll need make sure two backslashes R code due way special characters escaped. example, SQL Server Management Studio (SSMS) Azure Data Studio might call server T1PRANMSQL\\SQLPROD,60125, R adding server name ’d need call T1PRANMSQL\\\\SQLPROD,60125.","code":"# Library calls ====  library(odbc) library(DBI)  # Database connection ====  con <- DBI::dbConnect(odbc::odbc(),   Driver = \"ODBC Driver 17 for SQL Server\",   Server = \"server_name\",   Database = \"database_name\",   UID = \"\",   PWD = \"\",   Trusted_Connection = \"Yes\" )"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"reading-a-sql-script-into-r","dir":"Articles","previous_headings":"","what":"Reading a SQL script into R","title":"Connecting to SQL","text":"number standard characters found SQL scripts can cause issues reading SQL script within R created get_clean_sql() function assist . Assume connected database assigned connection con variable, use following line read cleaned version SQL script R. get_clean_sql() ignore lines code start USE specify database, database already specified connection setup.","code":"sql_query <- dfeR::get_clean_sql(\"path_to_sql_file.sql\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"executing-the-sql-query","dir":"Articles","previous_headings":"","what":"Executing the SQL query","title":"Connecting to SQL","text":"Now SQL query saved variable R environment can pass function execute database. ’s number potential ways , though common way use dbGetQuery() DBI package, setting statement cleaned SQL query. ’s important note dbGetQuery() intended work ‘SELECT’ style queries . ’re something isn’t ‘SELECT’ query, writing back SQL, consider using dbExecute() dbSendQuery() functions DBI package instead. side note, SQL query short, write directly function :","code":"sql_query_result <- DBI::dbGetQuery(con, statement = sql_query) sql_query_result <- DBI::dbGetQuery(   con,   statement = \"SELECT * FROM [my_database_table]\" )"},{"path":"https://dfe-analytical-services.github.io/dfeR/articles/connecting_to_sql.html","id":"troubleshooting","dir":"Articles","previous_headings":"Executing the SQL query","what":"Troubleshooting","title":"Connecting to SQL","text":"first advice hit error, check SQL script runs SQL Server Management Studio (SSMS) Azure Data Studio valid SQL ‘SELECT’ query returns single output. Assuming runs fine SSMS, next thing try set additional settings cleaning SQL script. can additional_settings argument get_clean_sql() function. add additional settings start SQL query sometimes necessary odbc DBI connection correctly execute query. troubleshooting tips, please see Interacting SQL database section Analysts’ Guide, contact Statistics Development Team support.","code":"sql_query <- dfeR::get_clean_sql(   \"path_to_sql_file.sql\",   additional_settings = TRUE )"},{"path":"https://dfe-analytical-services.github.io/dfeR/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Cam Race. Author, maintainer. Laura Selby. Author. Adam Robinson. Author. Jen Machin. Contributor. Jake Tufts. Contributor. Rich Bielby. Contributor. Menna Zayed. Contributor.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Race C, Selby L, Robinson (2024). dfeR: Common DfE R tasks. R package version 0.6.1, https://github.com/dfe-analytical-services/dfeR, https://dfe-analytical-services.github.io/dfeR/.","code":"@Manual{,   title = {dfeR: Common DfE R tasks},   author = {Cam Race and Laura Selby and Adam Robinson},   year = {2024},   note = {R package version 0.6.1,     https://github.com/dfe-analytical-services/dfeR},   url = {https://dfe-analytical-services.github.io/dfeR/}, }"},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"dfer-","dir":"","previous_headings":"","what":"Common DfE R tasks","title":"Common DfE R tasks","text":"goal dfeR help standardise R programming across Department Education (DfE), facilitate sharing business specific functions, making code easier read write. Credit lauraselby logo featuring Frederick!","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Common DfE R tasks","text":"package open DfE anything think useful programmers analysts can contributed. Functionality dfeR expected focus around following: DfE specific formatting helper functions Working DfE databases Templates analytical projects API wrappers commonly needed DfE analysis (don’t separate package) Geography lookup files helper functions Documentation included package far pkgdown site. also developing dfeshiny package, expect functions specific R Shiny applications live .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Common DfE R tasks","text":"dfeR currently available CRAN. time can install development version GitHub. using renv project (recommended): Otherwise:","code":"renv::install(\"dfe-analytical-services/dfeR\") # install.packages(\"devtools\") devtools::install_github(\"dfe-analytical-services/dfeR\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"proxy","dir":"","previous_headings":"","what":"Proxy","title":"Common DfE R tasks","text":"need setting proxy settings order able work R Git within DfE estate now ended. previously run proxy script previous versions dfeR package, contact Statistics Development Team assist cleaning system settings.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Common DfE R tasks","text":"Ideas dfeR first raised GitHub issue anyone free write code create pull request review. details contributing dfeR, see contributing guidelines.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Common DfE R tasks","text":"Please note dfeR project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/index.html","id":"examples","dir":"","previous_headings":"","what":"Examples","title":"Common DfE R tasks","text":"example functions within package: details functions available package, examples use , please see dfeR package reference documentation.","code":"library(dfeR)  # Prettify large numbers pretty_num(111111111, gbp = TRUE) #> [1] \"£111.11 million\" pretty_num(-11^8, dp = -1) #> [1] \"-210 million\"  # Convert bytes to readable size pretty_filesize(77777777) #> [1] \"77.78 MB\"  # Calculate elapsed time and present prettily start <- Sys.time() end <- Sys.time() + 789890 pretty_time_taken(start, end) #> [1] \"219 hours 24 minutes 50 seconds\"  # Round 5's up instead of bankers round used by round() in base R round_five_up(2.5) #> [1] 3 round(2.5) # base R #> [1] 2  # Custom formatting for academic and financial years format_ay(202425) #> [1] \"2024/25\" format_fy(202425) #> [1] \"2024-25\" format_ay_reverse(\"2024/25\") #> [1] \"202425\" format_fy_reverse(\"2024-25\") #> [1] \"202425\"  # Get Ward to PCon to LAD to LA to Rgn to Ctry lookup file my_data <- dfeR::wd_pcon_lad_la_rgn_ctry head(my_data) # show first 5 rows in console #>   first_available_year_included most_recent_year_included #> 1                          2017                      2017 #> 2                          2017                      2017 #> 3                          2017                      2020 #> 4                          2017                      2017 #> 5                          2017                      2020 #> 6                          2017                      2017 #>                ward_name  pcon_name              lad_name               la_name #> 1               Bastwell  Blackburn Blackburn with Darwen Blackburn with Darwen #> 2                Ormesby     Redcar  Redcar and Cleveland  Redcar and Cleveland #> 3            Burn Valley Hartlepool            Hartlepool            Hartlepool #> 4 Beardwood with Lammack  Blackburn Blackburn with Darwen Blackburn with Darwen #> 5               De Bruce Hartlepool            Hartlepool            Hartlepool #> 6           St Germain's     Redcar  Redcar and Cleveland  Redcar and Cleveland #>   region_name country_name ward_code pcon_code  lad_code new_la_code #> 1  North West      England E05001621 E14000570 E06000008   E06000008 #> 2  North East      England E05001518 E14000891 E06000003   E06000003 #> 3  North East      England E05008942 E14000733 E06000001   E06000001 #> 4  North West      England E05001622 E14000570 E06000008   E06000008 #> 5  North East      England E05008943 E14000733 E06000001   E06000001 #> 6  North East      England E05001519 E14000891 E06000003   E06000003 #>   region_code country_code #> 1   E12000002    E92000001 #> 2   E12000001    E92000001 #> 3   E12000001    E92000001 #> 4   E12000002    E92000001 #> 5   E12000001    E92000001 #> 6   E12000001    E92000001  # Get all countries dfeR::countries #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown  # Get all PCon names and codes for 2024 fetch_pcons(2024) |>   head() # show first 5 rows only #>   pcon_code                pcon_name #> 1 S14000045               Midlothian #> 2 S14000027     Na h-Eileanan an Iar #> 3 S14000021        East Renfrewshire #> 4 S14000048 North Ayrshire and Arran #> 5 S14000051      Orkney and Shetland #> 6 E14001440                   Redcar  # Get All LADs in Scotland in 2017 fetch_lads(2017, \"Scotland\") |>   head() # show first 5 rows only #>    lad_code           lad_name #> 1 S12000019         Midlothian #> 2 S12000015               Fife #> 3 S12000014            Falkirk #> 4 S12000013 Na h-Eileanan Siar #> 5 S12000018         Inverclyde #> 6 S12000011  East Renfrewshire  # Get all LAs in Scotland and Northern Ireland in 2022 fetch_las(2022, c(\"Scotland\", \"Northern Ireland\")) |>   head() # show first 5 rows only #>   new_la_code                              la_name #> 1   N09000003                              Belfast #> 2   N09000004             Causeway Coast and Glens #> 3   N09000002 Armagh City, Banbridge and Craigavon #> 4   N09000005              Derry City and Strabane #> 5   N09000001              Antrim and Newtownabbey #> 6   N09000006                  Fermanagh and Omagh  # Get all Welsh wards for 2021 fetch_wards(2021, \"Wales\") |>   head() # show first 5 rows only #>   ward_code                   ward_name #> 1 W05000981                      Aethwy #> 2 W05000982               Bro Aberffraw #> 3 W05000983                  Bro Rhosyr #> 4 W05000107 Tregarth & Mynydd Llandygai #> 5 W05000984                    Caergybi #> 6 W05000985              Canolbarth Môn  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown  fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":null,"dir":"Reference","previous_headings":"","what":"Validation for fetch location lookups — check_fetch_location_inputs","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"Validation fetch location lookups","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"","code":"check_fetch_location_inputs(year_input, country_input)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"year_input value years input country_input value countries input","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/check_fetch_location_inputs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Validation for fetch location lookups — check_fetch_location_inputs","text":"nothing, unless failure, give error","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":null,"dir":"Reference","previous_headings":"","what":"Comma separate — comma_sep","title":"Comma separate — comma_sep","text":"Adds separating commas big numbers. value numeric return value unchanged string.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Comma separate — comma_sep","text":"","code":"comma_sep(number, nsmall = 0L)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Comma separate — comma_sep","text":"number number comma separated nsmall minimum number digits right decimal point","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Comma separate — comma_sep","text":"string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/comma_sep.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Comma separate — comma_sep","text":"","code":"comma_sep(100) #> [1] \"100\" comma_sep(1000) #> [1] \"1,000\" comma_sep(3567000) #> [1] \"3,567,000\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for valid country names and codes — countries","title":"Lookup for valid country names and codes — countries","text":"lookup ONS geography country names codes, well custom DfE names codes. used definitive list screening open data published DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for valid country names and codes — countries","text":"","code":"countries"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"countries","dir":"Reference","previous_headings":"","what":"countries","title":"Lookup for valid country names and codes — countries","text":"data frame 10 rows 2 columns: country_name Country name country_code Country code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/countries.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for valid country names and codes — countries","text":"curated explore.statistics@education.gov.uk, ONS codes sourced https://geoportal.statistics.gov.uk/search?q=countries%20names%20and%20codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates a pre-populated project for DfE R — create_project","title":"Creates a pre-populated project for DfE R — create_project","text":"Creates pre-populated project DfE R","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates a pre-populated project for DfE R — create_project","text":"","code":"create_project(   path,   init_renv = TRUE,   include_structure_for_pkg = FALSE,   create_publication_proj = FALSE,   include_github_gitignore,   ... )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates a pre-populated project for DfE R — create_project","text":"path Path new project init_renv Boolean; initiate renv project. Default set true. include_structure_for_pkg Boolean; Additional folder structure package development. Default set false. create_publication_proj Boolean; folder structure publication project. Default set false. include_github_gitignore Boolean; strict .gitignore file GitHub created. ... Additional parameters, currently used","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates a pre-populated project for DfE R — create_project","text":"return values, project contents created","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Creates a pre-populated project for DfE R — create_project","text":"function creates new project custom folder structure. sets R/ folder template function scripts, initializes {testthat} adds tests function scripts, builds core project structure, creates .gitignore file, creates readme, optionally initializes {renv}.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_project.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates a pre-populated project for DfE R — create_project","text":"","code":"if (FALSE) { # \\dontrun{  # Call the function to create a new project dfeR::create_project(   path = \"C:/path/to/your/new/project\",   init_renv = TRUE,   include_structure_for_pkg = FALSE,   create_publication_proj = FALSE,   include_github_gitignore = TRUE ) } # }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":null,"dir":"Reference","previous_headings":"","what":"Smush lookups together to make a time series — create_time_series_lookup","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"Take list tidied files, likely produced tidy_raw_lookup function append together","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"","code":"create_time_series_lookup(lookups_list)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"lookups_list list data frames new lookup table, usually output tidy_raw_lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"single data.frame lookup files combined","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/create_time_series_lookup.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Smush lookups together to make a time series — create_time_series_lookup","text":"Updates first_available_year_included most_recent_year_included columns accurate full ser-EES","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/dfeR-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dfeR: Common DfE R tasks — dfeR-package","title":"dfeR: Common DfE R tasks — dfeR-package","text":"package contains R functions allow DfE analysts re-use code common analytical tasks undertaken across Department.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/dfeR-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dfeR: Common DfE R tasks — dfeR-package","text":"Maintainer: Cam Race cameron.race@education.gov.uk Authors: Laura Selby laura.selby@education.gov.uk Adam Robinson contributors: Jen Machin jen.machin@education.gov.uk [contributor] Jake Tufts jake.tufts@education.gov.uk [contributor] Rich Bielby richard.bielby@education.gov.uk (ORCID) [contributor] Menna Zayed menna.zayed@education.gov.uk [contributor]","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Westminster parliamentary constituencies — fetch","title":"Fetch Westminster parliamentary constituencies — fetch","text":"Fetch data frame Westminster Parliamentary Constituencies given year country based dfeR::wd_pcon_lad_la_rgn_ctry file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Westminster parliamentary constituencies — fetch","text":"","code":"fetch_pcons(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Westminster parliamentary constituencies — fetch","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Westminster parliamentary constituencies — fetch","text":"data frame unique location names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Westminster parliamentary constituencies — fetch","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch countries — fetch_countries","title":"Fetch countries — fetch_countries","text":"Fetch countries","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch countries — fetch_countries","text":"","code":"fetch_countries()"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch countries — fetch_countries","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_countries.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch countries — fetch_countries","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch local authority districts — fetch_lads","title":"Fetch local authority districts — fetch_lads","text":"Fetch local authority districts","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch local authority districts — fetch_lads","text":"","code":"fetch_lads(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch local authority districts — fetch_lads","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch local authority districts — fetch_lads","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_lads.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch local authority districts — fetch_lads","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch local authorities — fetch_las","title":"Fetch local authorities — fetch_las","text":"Fetch local authorities","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch local authorities — fetch_las","text":"","code":"fetch_las(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch local authorities — fetch_las","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch local authorities — fetch_las","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_las.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch local authorities — fetch_las","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch locations for a given lookup — fetch_locations","title":"Fetch locations for a given lookup — fetch_locations","text":"Helper function fetch_xxx() functions save repeating code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch locations for a given lookup — fetch_locations","text":"","code":"fetch_locations(lookup_data, cols, year, countries)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch locations for a given lookup — fetch_locations","text":"lookup_data lookup data use extract locations cols columns extract main lookup table year year locations extract, \"\" skip filtering return possible locations countries countries locations take , \"\" skip filtering return ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_locations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch locations for a given lookup — fetch_locations","text":"data frame location names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch regions — fetch_regions","title":"Fetch regions — fetch_regions","text":"Fetch regions","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch regions — fetch_regions","text":"","code":"fetch_regions()"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch regions — fetch_regions","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_regions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch regions — fetch_regions","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch wards — fetch_wards","title":"Fetch wards — fetch_wards","text":"Fetch wards","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch wards — fetch_wards","text":"","code":"fetch_wards(year = \"All\", countries = \"All\")"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch wards — fetch_wards","text":"year year filter locations , default \"\", options 2017, 2019, 2020, 2021, 2022\", 2023, 2024 countries vector desired countries filter locations , default \"\", can vector options \"England\", \"Scotland\", \"Wales\" \"Northern Ireland\"","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch wards — fetch_wards","text":"data frame unique location names codes","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/fetch_wards.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch wards — fetch_wards","text":"","code":"# Using head() to show only top 5 rows for examples head(fetch_wards()) #>   ward_code              ward_name #> 1 E05001621               Bastwell #> 2 E05001518                Ormesby #> 3 E05008942            Burn Valley #> 4 E05001622 Beardwood with Lammack #> 5 E05008943               De Bruce #> 6 E05001519           St Germain's  head(fetch_pcons()) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(2023)) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  head(fetch_pcons(countries = \"Scotland\")) #>   pcon_code                 pcon_name #> 1 S14000045                Midlothian #> 2 S14000041 Kirkcaldy and Cowdenbeath #> 3 S14000028                   Falkirk #> 4 S14000036                Glenrothes #> 5 S14000027      Na h-Eileanan an Iar #> 6 S14000038                Inverclyde  head(fetch_pcons(year = 2023, countries = c(\"England\", \"Wales\"))) #>   pcon_code      pcon_name #> 1 E14000570      Blackburn #> 2 E14000891         Redcar #> 3 E14000733     Hartlepool #> 4 E14000970 Stockton North #> 5 E14000819  Middlesbrough #> 6 E14000971 Stockton South  fetch_lads(2024, \"Wales\") #>     lad_code          lad_name #> 1  W06000001  Isle of Anglesey #> 2  W06000002           Gwynedd #> 3  W06000003             Conwy #> 4  W06000011           Swansea #> 5  W06000009     Pembrokeshire #> 6  W06000006           Wrexham #> 7  W06000004      Denbighshire #> 8  W06000005        Flintshire #> 9  W06000008        Ceredigion #> 10 W06000010   Carmarthenshire #> 11 W06000012 Neath Port Talbot #> 12 W06000014 Vale of Glamorgan #> 13 W06000022           Newport #> 14 W06000023             Powys #> 15 W06000020           Torfaen #> 16 W06000016 Rhondda Cynon Taf #> 17 W06000019     Blaenau Gwent #> 18 W06000018        Caerphilly #> 19 W06000021     Monmouthshire #> 20 W06000013          Bridgend #> 21 W06000015           Cardiff #> 22 W06000024    Merthyr Tydfil  fetch_las(2022, \"Northern Ireland\") #>    new_la_code                              la_name #> 1    N09000003                              Belfast #> 2    N09000004             Causeway Coast and Glens #> 3    N09000002 Armagh City, Banbridge and Craigavon #> 4    N09000005              Derry City and Strabane #> 5    N09000001              Antrim and Newtownabbey #> 6    N09000006                  Fermanagh and Omagh #> 7    N09000008                  Mid and East Antrim #> 8    N09000010               Newry, Mourne and Down #> 9    N09000009                           Mid Ulster #> 10   N09000011                  Ards and North Down #> 11   N09000007              Lisburn and Castlereagh  # The following have no specific years available and return all values fetch_regions() #>    region_code                               region_name #> 1    E12000001                                North East #> 2    E12000002                                North West #> 3    E12000003                  Yorkshire and The Humber #> 4    E12000004                             East Midlands #> 5    E12000005                             West Midlands #> 6    E12000006                           East of England #> 7    E12000007                                    London #> 8    E12000008                                South East #> 9    E12000009                                South West #> 10   E13000001                              Inner London #> 11   E13000002                              Outer London #> 12           z            Outside of England and unknown #> 13           z Outside of the United Kingdom and unknown #> 14           z                        Outside of England #> 15           z                 Outside of United Kingdom #> 16           z                                   Unknown fetch_countries() #>    country_code                              country_name #> 1     E92000001                                   England #> 2     K02000001                            United Kingdom #> 3     K03000001                             Great Britain #> 4     K04000001                         England and Wales #> 5     N92000002                          Northern Ireland #> 6     S92000003                                  Scotland #> 7     W92000004                                     Wales #> 8             z       England, Wales and Northern Ireland #> 9             z            Outside of England and unknown #> 10            z Outside of the United Kingdom and unknown"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":null,"dir":"Reference","previous_headings":"","what":"Format academic year — format_ay","title":"Format academic year — format_ay","text":"function formats academic year variables reporting purposes. convert academic year input 201516 format 2015/16 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format academic year — format_ay","text":"","code":"format_ay(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format academic year — format_ay","text":"year Academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format academic year — format_ay","text":"Character vector formatted academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format academic year — format_ay","text":"accepts numerical character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format academic year — format_ay","text":"","code":"format_ay(201617) #> [1] \"2016/17\" format_ay(\"201617\") #> [1] \"2016/17\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":null,"dir":"Reference","previous_headings":"","what":"Undo academic year formatting — format_ay_reverse","title":"Undo academic year formatting — format_ay_reverse","text":"function converts academic year variables back 201617 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Undo academic year formatting — format_ay_reverse","text":"","code":"format_ay_reverse(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Undo academic year formatting — format_ay_reverse","text":"year Academic year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Undo academic year formatting — format_ay_reverse","text":"Unformatted 6 digit year string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Undo academic year formatting — format_ay_reverse","text":"accepts character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_ay_reverse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Undo academic year formatting — format_ay_reverse","text":"","code":"format_ay_reverse(\"2016/17\") #> [1] \"201617\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":null,"dir":"Reference","previous_headings":"","what":"Format financial year — format_fy","title":"Format financial year — format_fy","text":"function formats financial year variables reporting purposes. convert year input 201516 format 2015-16 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format financial year — format_fy","text":"","code":"format_fy(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format financial year — format_fy","text":"year Financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format financial year — format_fy","text":"Character vector formatted financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format financial year — format_fy","text":"accepts numerical character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format financial year — format_fy","text":"","code":"format_fy(201617) #> [1] \"2016-17\" format_fy(\"201617\") #> [1] \"2016-17\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":null,"dir":"Reference","previous_headings":"","what":"Undo financial year formatting — format_fy_reverse","title":"Undo financial year formatting — format_fy_reverse","text":"function converts financial year variables back 201617 format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Undo financial year formatting — format_fy_reverse","text":"","code":"format_fy_reverse(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Undo financial year formatting — format_fy_reverse","text":"year Financial year","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Undo financial year formatting — format_fy_reverse","text":"Unformatted 6 digit year string","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Undo financial year formatting — format_fy_reverse","text":"accepts character arguments.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/format_fy_reverse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Undo financial year formatting — format_fy_reverse","text":"","code":"format_fy_reverse(\"2016-17\") #> [1] \"201617\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a cleaned SQL script into R — get_clean_sql","title":"Get a cleaned SQL script into R — get_clean_sql","text":"function cleans SQL script, ready using within R DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a cleaned SQL script into R — get_clean_sql","text":"","code":"get_clean_sql(filepath, additional_settings = FALSE)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a cleaned SQL script into R — get_clean_sql","text":"filepath path SQL script additional_settings TRUE FALSE boolean addition settings start SQL script","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a cleaned SQL script into R — get_clean_sql","text":"Cleaned string containing SQL query","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_clean_sql.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a cleaned SQL script into R — get_clean_sql","text":"","code":"# This assumes you have already set up a database connection # and that the filepath for the function exists # For more details see the vignette on connecting to SQL  # Pull a cleaned version of the SQL file into R if (file.exists(\"your_script.sql\")) {   sql_query <- get_clean_sql(\"your_script.sql\") }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":null,"dir":"Reference","previous_headings":"","what":"Get LAD to Region lookup — get_lad_region","title":"Get LAD to Region lookup — get_lad_region","text":"Helper function extract data Ward-LAD-Region-County-Country file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get LAD to Region lookup — get_lad_region","text":"","code":"get_lad_region(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get LAD to Region lookup — get_lad_region","text":"year last two digits year lookup, available years : 2017, 2018, 2019, 2020, 2022, 2023","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_lad_region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get LAD to Region lookup — get_lad_region","text":"data.frame individual year lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch ONS Open Geography API data — get_ons_api_data","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"Helper function takes data set id parameters query parse data ONS Open Geography API. Technically uses POST request rather GET request.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"","code":"get_ons_api_data(   data_id,   query_params = list(where = \"1=1\", outFields = \"*\", outSR = \"4326\", f = \"json\"),   batch_size = 200,   verbose = TRUE )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"data_id id data set query, can found Open Geography Portal query_params query parameters pass API, see ESRI documentation information query parameters - ESRI Query (Feature Service/Layer) batch_size number rows per query. 250 default, hit errors try lowering . API limit 1000 2000 rows per query, truth, actual limit method lower every ObjectId queried pasted query URL every row included batch, especial Id's go 1,000s 10,000s increase size URL risk hitting limit. verbose TRUE FALSE boolean. TRUE default. FALSE turn messages console update function ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"parsed data.frame geographic names codes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"pre-query understand ObjectIds query want, query retrieve Ids directly batches stacking whole thing back together work around row limits single query. Open Geography Portal, find data set interested use query explorer find information query.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_ons_api_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch ONS Open Geography API data — get_ons_api_data","text":"","code":"if (interactive()) {   # Specify some parameters   get_ons_api_data(     data_id = \"LAD23_RGN23_EN_LU\",     query_params =       list(outFields = \"column1, column2\", outSR = \"4326\", f = \"json\")   )    # Just fetch everything   get_ons_api_data(data_id = \"LAD23_RGN23_EN_LU\") }"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"Helper function extract data Ward-PCon-LAD-UTLA file","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"","code":"get_wd_pcon_lad_la(year)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"year last two digits year lookup, available years : 2017, 2019, 2020, 2021, 2022, 2023, 2024","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/get_wd_pcon_lad_la.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Ward-PCon-LAD-LA data — get_wd_pcon_lad_la","text":"data.frame individual year lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"lookup ONS geography shorthands respective column names line DfE open data standards.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"","code":"ons_geog_shorthands"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"ons-geog-shorthands","dir":"Reference","previous_headings":"","what":"ons_geog_shorthands","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"data frame 7 rows 3 columns: ons_level_shorthands ONS shorthands used lookup files name_column DfE names geography name columns code_column DfE names geography code columns","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"curated explore.statistics@education.gov.uk","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/ons_geog_shorthands.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lookup for ONS geography columns shorthands — ons_geog_shorthands","text":"GOR (Government Office Region) predecessor RGN.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":null,"dir":"Reference","previous_headings":"","what":"Pretty numbers into readable file size — pretty_filesize","title":"Pretty numbers into readable file size — pretty_filesize","text":"Converts raw file size bytes readable format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pretty numbers into readable file size — pretty_filesize","text":"","code":"pretty_filesize(filesize)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pretty numbers into readable file size — pretty_filesize","text":"filesize file size bytes","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pretty numbers into readable file size — pretty_filesize","text":"string containing prettified file size","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Pretty numbers into readable file size — pretty_filesize","text":"Designed used conjunction file.size() function base R. Presents kilobytes, megabytes gigabytes. Shows bytes 1 KB, kilobytes 1 MB, megabytes 1GB, show gigabytes anything larger. Rounds end result 2 decimal places. Using base 10 (decimal), 1024 bytes 1,024 KB.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_filesize.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pretty numbers into readable file size — pretty_filesize","text":"","code":"pretty_filesize(2) #> [1] \"2 bytes\" pretty_filesize(549302) #> [1] \"549.3 KB\" pretty_filesize(9872948939) #> [1] \"9.87 GB\" pretty_filesize(1) #> [1] \"1 byte\" pretty_filesize(1000) #> [1] \"1 KB\" pretty_filesize(1000^2) #> [1] \"1 MB\" pretty_filesize(10^9) #> [1] \"1 GB\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":null,"dir":"Reference","previous_headings":"","what":"Prettify big numbers into a readable format — pretty_num","title":"Prettify big numbers into a readable format — pretty_num","text":"Uses .numeric() force numeric value formats prettily easy presentation console messages, reports, dashboards. rounds 0 decimal places default, adds comma separators. Expect commonly used adding pound symbol, percentage symbol, +/- prefixed based value. applying multiple unpredictable values want preserve non-numeric symbol \"x\" \"c\" data available, use ignore_na = TRUE argument return values unaffected. want customise NA values returned , use alt_na argument. function silences warning around NAs introduced coercion.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prettify big numbers into a readable format — pretty_num","text":"","code":"pretty_num(   value,   prefix = \"\",   gbp = FALSE,   suffix = \"\",   dp = 0,   ignore_na = FALSE,   alt_na = FALSE,   nsmall = NULL )"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prettify big numbers into a readable format — pretty_num","text":"value value prettified prefix prefix value, \"+/-\" automatically assign + - based value gbp whether add pound symbol , defaults suffix suffix value, e.g. \"%\" dp number decimal places round , 0 default. ignore_na whether skip function strings converted return original value alt_na alternative value return place NA, e.g. \"x\" nsmall minimum number digits right decimal point. NULL, value dp used.  value dp less 0, nsmall automatically set 0.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prettify big numbers into a readable format — pretty_num","text":"string featuring prettified value","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prettify big numbers into a readable format — pretty_num","text":"","code":"# On individual values pretty_num(5789, gbp = TRUE) #> [1] \"£5,789\" pretty_num(564, prefix = \"+/-\") #> [1] \"+564\" pretty_num(567812343223, gbp = TRUE, prefix = \"+/-\") #> [1] \"+£568 billion\" pretty_num(11^9, gbp = TRUE, dp = 3) #> [1] \"£2.358 billion\" pretty_num(-11^8, gbp = TRUE, dp = -1) #> [1] \"-£210 million\" pretty_num(43.3, dp = 1, nsmall = 2) #> [1] \"43.30\" pretty_num(\"56.089\", suffix = \"%\") #> [1] \"56%\" pretty_num(\"x\") #> [1] NA pretty_num(\"x\", ignore_na = TRUE) #> [1] \"x\" pretty_num(\"nope\", alt_na = \"x\") #> [1] \"x\"  # Applied over an example vector vector <- c(3998098008, -123421421, \"c\", \"x\") pretty_num(vector) #> [1] \"4 billion\"    \"-123 million\" NA             NA             pretty_num(vector, prefix = \"+/-\", gbp = TRUE) #> [1] \"+£4 billion\"   \"-£123 million\" NA              NA               # Return original values if NA pretty_num(vector, ignore_na = TRUE) #> [1] \"4 billion\"    \"-123 million\" \"c\"            \"x\"             # Return alternative value in place of NA pretty_num(vector, alt_na = \"z\") #> [1] \"4 billion\"    \"-123 million\" \"z\"            \"z\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"can format number character values data frame passing arguments dfeR::pretty_num(). Use parameters include_columns exclude_columns specify columns formatting.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"","code":"pretty_num_table(data, include_columns = NULL, exclude_columns = NULL, ...)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"data data frame containing columns formatted. include_columns character vector specifying columns format. NULL (default), columns considered formatting. exclude_columns character vector specifying columns exclude formatting. NULL (default), columns excluded. include_columns exclude_columns provided , include_columns takes precedence. ... Additional arguments passed dfeR::pretty_num() , dp (decimal places) controlling number decimal points.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"data frame columns formatted using dfeR::pretty_num().","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"function first checks columns specified inclusion via include_columns. none provided, checks columns specified exclusion via exclude_columns. neither specified, columns data frame formatted.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_num_table.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format a data frame with dfeR::pretty_num(). — pretty_num_table","text":"","code":"# Example data frame df <- data.frame(   a = c(1.234, 5.678, 9.1011),   b = c(10.1112, 20.1314, 30.1516),   c = c(\"A\", \"B\", \"C\") )  # Apply formatting to all columns pretty_num_table(df, dp = 2) #>      a     b  c #> 1 1.23 10.11 NA #> 2 5.68 20.13 NA #> 3 9.10 30.15 NA  # Apply formatting to only selected columns pretty_num_table(df, include_columns = c(\"a\"), dp = 2) #>      a       b c #> 1 1.23 10.1112 A #> 2 5.68 20.1314 B #> 3 9.10 30.1516 C  # Apply formatting to all columns except specified ones pretty_num_table(df, exclude_columns = c(\"b\"), dp = 2) #>      a       b  c #> 1 1.23 10.1112 NA #> 2 5.68 20.1314 NA #> 3 9.10 30.1516 NA  # Apply formatting to all columns except specified ones and # provide alternative value for NAs pretty_num_table(df, alt_na = \"[z]\", exclude_columns = c(\"b\"), dp = 2) #>      a       b   c #> 1 1.23 10.1112 [z] #> 2 5.68 20.1314 [z] #> 3 9.10 30.1516 [z]"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate elapsed time between two points and present prettily — pretty_time_taken","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"Converts start end value readable time format.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"","code":"pretty_time_taken(start_time, end_time)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"start_time start time readable .POSIXct end_time end time readable .POSIXct","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"string containing prettified elapsed time","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"Designed used Sys.time() tracking start end times. Shows seconds 119 seconds, minutes 119 minutes, hours anything larger. Input start end times must convertible POSIXct format.","code":""},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/pretty_time_taken.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate elapsed time between two points and present prettily — pretty_time_taken","text":"","code":"pretty_time_taken(   \"2024-03-23 07:05:53 GMT\",   \"2024-03-23 12:09:56 GMT\" ) #> [1] \"5 hours 4 minutes 3 seconds\"  # Track the start and end time of a process start <- Sys.time() Sys.sleep(0.1) end <- Sys.time()  # Use this function to present it prettily pretty_time_taken(start, end) #> [1] \"0.1 seconds\""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":null,"dir":"Reference","previous_headings":"","what":"Lookup for valid region names and codes — regions","title":"Lookup for valid region names and codes — regions","text":"lookup ONS geography region names codes England. lookups Northern Ireland, Scotland Wales regions.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lookup for valid region names and codes — regions","text":"","code":"regions"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"regions","dir":"Reference","previous_headings":"","what":"regions","title":"Lookup for valid region names and codes — regions","text":"data frame 16 rows 2 columns: region_name Region name region_code Region code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Lookup for valid region names and codes — regions","text":"curated explore.statistics@education.gov.uk, ONS codes sourced https://geoportal.statistics.gov.uk/search?q=NAC_RGN","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/regions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lookup for valid region names and codes — regions","text":"Also included inner outer London county split DfE frequently publish regions, well custom DfE names codes. used definitive list screening open data published DfE.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":null,"dir":"Reference","previous_headings":"","what":"Round five up — round_five_up","title":"Round five up — round_five_up","text":"Round number specified number places, 5's rounded .","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round five up — round_five_up","text":"","code":"round_five_up(number, dp = 0)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round five up — round_five_up","text":"number number rounded dp number decimal places round , default 0","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round five up — round_five_up","text":"Rounded number","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Round five up — round_five_up","text":"Rounds 0 decimal places default. can use negative value decimal places. example: -1 round nearest 10 -2 round nearest 100 . alternative round base R, uses bankers round. information see round() documentation.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/round_five_up.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Round five up — round_five_up","text":"","code":"# No dp set round_five_up(2485.85) #> [1] 2486  # With dp set round_five_up(2485.85, 2) #> [1] 2485.85 round_five_up(2485.85, 1) #> [1] 2485.9 round_five_up(2485.85, 0) #> [1] 2486 round_five_up(2485.85, -1) #> [1] 2490 round_five_up(2485.85, -2) #> [1] 2500"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":null,"dir":"Reference","previous_headings":"","what":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"Takes file open geography portal tidies ready appending existing lookup","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"","code":"tidy_raw_lookup(raw_lookup_file)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"raw_lookup_file data.frame lookup file downloaded Open Geography Portal, e.g. output get_ons_api_data(), data frame R memory","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/tidy_raw_lookup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tidy a lookup file from the Open Geography Portal — tidy_raw_lookup","text":"data frame tidied lookup file Function rename columns using dfeR::ons_geog_shorthands table col_name single column name updated based shorthand lookup table string new column name match found, match found original name returned","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":null,"dir":"Reference","previous_headings":"","what":"Controllable console messages — toggle_message","title":"Controllable console messages — toggle_message","text":"Quick expansion message() function aimed use functions easy addition global verbose TRUE / FALSE argument toggle messages ","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Controllable console messages — toggle_message","text":"","code":"toggle_message(..., verbose)"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Controllable console messages — toggle_message","text":"... message normally pass message(). See message details verbose logical, usually variable passed function using within","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/toggle_message.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Controllable console messages — toggle_message","text":"","code":"# Usually used in a function my_function <- function(count_fingers, verbose) {   toggle_message(\"I have \", count_fingers, \" fingers\", verbose = verbose)   fingers_thumbs <- count_fingers + 2   toggle_message(\"I have \", fingers_thumbs, \" digits\", verbose = verbose) }  my_function(5, verbose = FALSE) my_function(5, verbose = TRUE) #> I have 5 fingers #> I have 7 digits  # Can be used in isolation toggle_message(\"I want the world to read this!\", verbose = TRUE) #> I want the world to read this! toggle_message(\"I ain't gonna show this message!\", verbose = FALSE)  count_fingers <- 5 toggle_message(\"I have \", count_fingers, \" fingers\", verbose = TRUE) #> I have 5 fingers"},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":null,"dir":"Reference","previous_headings":"","what":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"lookup showing hierarchy ward Westminster parliamentary constituency local authority district local authority region country years 2017, 2019, 2020, 2021, 2022, 2023 2024.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"","code":"wd_pcon_lad_la_rgn_ctry"},{"path":[]},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"wd-pcon-lad-la-rgn-ctry","dir":"Reference","previous_headings":"","what":"wd_pcon_lad_la_rgn_ctry","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"data frame 24,629 rows 14 columns: first_available_year_included First year lookups see location most_recent_year_included Last year lookups see location ward_name Ward name pcon_name Parliamentary constituency name lad_name Local authority district name la_name Local authority name region_name Region name country_code Country name ward_code 9 digit ward code pcon_code 9 digit westminster constituency code lad_code 9 digit local authority district code new_la_code 9 digit local authority code region_code 9 digit region code country_code 9 digit country code","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"https://geoportal.statistics.gov.uk/search?tags=lup_wd_pcon_lad_utla https://geoportal.statistics.gov.uk/search?q=lup_wd_lad_cty_rgn_gor_ctry","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/reference/wd_pcon_lad_la_rgn_ctry.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Ward to Constituency to LAD to LA to Region to Country lookup — wd_pcon_lad_la_rgn_ctry","text":"Changes made original lookup: original lookup ONS uses Upper Tier Local Authority, update metropolitan local authority use local authority district local authority match DfE publish data local authorities. noticed 2017 version, Glasgow East constituency code S1400030 instead usual S14000030, assumed error change data Glasgow East S14000030 2017. joined regions using Ward LAD County Region file. joined countries based E / N / S / W start codes. Scotland published regions 2017, given rest years Scotland region, forced 2017 complete data set.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-061","dir":"Changelog","previous_headings":"","what":"dfeR 0.6.1","title":"dfeR 0.6.1","text":"Patch update pretty_num() function dp argument’s default 0.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-060","dir":"Changelog","previous_headings":"","what":"dfeR 0.6.0","title":"dfeR 0.6.0","text":"Update pretty_num : can take single multiple values. argument nsmall allows control number digits displayed rounding. Add pretty_num_table() uses pretty_num() format numbers readable format data frames. customization provided pretty_num.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-051","dir":"Changelog","previous_headings":"","what":"dfeR 0.5.1","title":"dfeR 0.5.1","text":"Patch update get_clean_sql() function ignore lines starting ‘USE’.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-050","dir":"Changelog","previous_headings":"","what":"dfeR 0.5.0","title":"dfeR 0.5.0","text":"Add following lookup data sets package: ons_geog_shorthands countries regions wd_pcon_lad_la_rgn_ctry Add following fetch_locations() functions: fetch_wards() fetch_pcons() fetch_lads() fetch_las() fetch_regions() fetch_countries() Add wrapper ONS Open Geography Portal API: get_ons_api_data() Add helper turning messages : toggle_message()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-041","dir":"Changelog","previous_headings":"","what":"dfeR 0.4.1","title":"dfeR 0.4.1","text":"Update comma_sep() function allow non-numeric values instead throwing error, now returns unchanged.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-040","dir":"Changelog","previous_headings":"","what":"dfeR 0.4.0","title":"dfeR 0.4.0","text":"Add function creates DfE R project: create_project()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-031","dir":"Changelog","previous_headings":"","what":"dfeR 0.3.1","title":"dfeR 0.3.1","text":"Fix bug get_clean_sql() using additional settings lose original SQL statement.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-030","dir":"Changelog","previous_headings":"","what":"dfeR 0.3.0","title":"dfeR 0.3.0","text":"Add pretty_* functions presenting pretty numbers: pretty_num() pretty_filesize() pretty_time_taken() Add helper function comma separating numbers: comma_sep()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-020","dir":"Changelog","previous_headings":"","what":"dfeR 0.2.0","title":"dfeR 0.2.0","text":"Add function formatting financial years: format_fy() Add reversing functions academic financial years: format_ay_reverse() format_fy_reverse() Add function grabbing cleaning SQL script, vignette connecting SQL. get_clean_sql()","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-011","dir":"Changelog","previous_headings":"","what":"dfeR 0.1.1","title":"dfeR 0.1.1","text":"Add default value decimal place argument round_five_up() function.","code":""},{"path":"https://dfe-analytical-services.github.io/dfeR/news/index.html","id":"dfer-010","dir":"Changelog","previous_headings":"","what":"dfeR 0.1.0","title":"dfeR 0.1.0","text":"Relaunch package two functions: format_ay() round_five_up()","code":""}]