Updated documentation with geog_level_lookup

R/create_package_data.R

@@ -0,0 +1,36 @@
+#' Create geographic_level API shorthand to natural language look-up
+#'
+#' @description
+#' Script for updating the package data file geog_level_lookup.rda with the look-up between API
+#' shorthands and natural language versions of geographic levels.
+#'
+#' @returns NULL
+#' @keywords internal
+#'
+#' @examples
+#' \dontrun{
+#' create_geog_level_lookup()
+#' }
+create_geog_level_lookup <- function() {
+  geog_level_lookup <- data.frame(
+    api_friendly = c(
+      "EDA", "INST", "LA", "LAD",
+      "LEP", "LSIP",
+      "MAT", "MCA",
+      "NAT", "OA",
+      "PA", "PCON", "PROV",
+      "REG", "RSC", "SCH", "SPON", "WARD"
+    ),
+    human_friendly = c(
+      "English devolved area", "Institution", "Local authority", "Local authority district",
+      "Local enterprise partnership", "Local skills improvement plan area",
+      "Multi-academy trust", "MCA",
+      "National", "Opportunity area",
+      "Planning area", "Parliamentary constituency", "Provider",
+      "Regional", "Regional school commissioner region", "School", "Sponsor", "Ward"
+    )
+  )
+  # write it out to the data folder
+
+  usethis::use_data(geog_level_lookup, overwrite = TRUE)
+}

R/datasets_documentation.R

@@ -0,0 +1,12 @@
+#' Look-up for API geographic_level shorthands
+#'
+#' A look-up of API geographic_level shorthands and their respective natural forms.
+#'
+#' @format ## `geog_level_lookup`
+#' A data frame with 18 rows and 2 columns:
+#' \describe{
+#'   \item{api_friendly}{API geographic level shorthands}
+#'   \item{human_friendly}{Narural language geographic levels}
+#' }
+#' @source curated by explore.statistics@@education.gov.uk
+"geog_level_lookup"

R/query_dataset_utils.R

@@ -146,9 +146,9 @@ todf_geographies <- function(geographies) {
   } else {
     stop("The geographies parameter should be given as either a data frame, vector or string.")
   }
-  if (any(geog_level_lookup$human_friendly %in% geographies$geographic_level)) {
+  if (any(eesyapi::geog_level_lookup$human_friendly %in% geographies$geographic_level)) {
     geographies <- geographies |>
-      dplyr::left_join(geog_level_lookup, by = c("geographic_level" = "human_friendly")) |>
+      dplyr::left_join(eesyapi::geog_level_lookup, by = c("geographic_level" = "human_friendly")) |>
       dplyr::mutate(
         geographic_level = dplyr::case_when(
           !is.na(api_friendly) ~ api_friendly,
@@ -157,9 +157,9 @@ todf_geographies <- function(geographies) {
       ) |>
       dplyr::select(-"api_friendly")
   }
-  if (any(geog_level_lookup$human_friendly %in% geographies$location_level)) {
+  if (any(eesyapi::geog_level_lookup$human_friendly %in% geographies$location_level)) {
     geographies <- geographies |>
-      dplyr::left_join(geog_level_lookup, by = c("location_level" = "human_friendly")) |>
+      dplyr::left_join(eesyapi::geog_level_lookup, by = c("location_level" = "human_friendly")) |>
       dplyr::mutate(
         location_level = dplyr::case_when(
           !is.na(api_friendly) ~ api_friendly,

_pkgdown.yml

@@ -21,7 +21,8 @@ reference:
   contents:
   - starts_with("api_url")
 
-- title: Generate example IDs and data
+- title: Generate example IDs and reference data
   desc: These functions are used widely to create working example code and tests
   contents:
   - starts_with("example")
+  - geog_level_lookup