Dev/metadata

NAMESPACE

@@ -4,5 +4,6 @@ export(get_hscp_locality)
 export(get_simd_datazone)
 export(get_simd_postcode)
 export(get_spd)
+export(metadata)
 importFrom(rlang,.data)
 importFrom(tibble,tibble)

R/get_spd.R

@@ -31,6 +31,8 @@ get_spd <- function(version = "latest", col_select = NULL) {
     "Scottish Postcode Directory"
   )
 
+  metadata_dir <- fs::path(dir, "Metadata")
+
   if (version == "latest") {
     spd_path <- find_latest_file(
       directory = dir,
@@ -53,8 +55,22 @@ get_spd <- function(version = "latest", col_select = NULL) {
     )
   }
 
-  return(read_file(
+  metadata <- readr::read_csv(fs::path(metadata_dir, "spd_metadata.csv")) %>%
+    dplyr::select(1:2) %>%
+    stats::setNames(c("variable", "description"))
+
+  inform_metadata_access()
+
+  inform_metadata_version(version)
+
+  cli::cat_line("\n--- Metadata ---\n", col = "blue")
+  cli::cat_print(metadata)
+  cli::cat_line("")
+
+  spd <- read_file(
     spd_path,
     col_select = {{ col_select }}
-  ))
+  )
+  spd <- set_metadata(spd, metadata)
+  return(spd)
 }

R/metadata.R

@@ -0,0 +1,41 @@
+#' Function to access metadata
+#'
+#' @param data Dataset imported via e.g. `get_spd()`.
+#'
+#' @returns
+#' Metadata `tibble` associated with dataset.
+#'
+#' @examples
+#' library(phslookups)
+#'
+#' \dontrun{
+#' spd <- get_spd()
+#'
+#' metadata(spd)
+#' }
+#'
+#' @export
+metadata <- function(data) {
+  out <- attr(data, "metadata")
+
+  if (is.null(out)) {
+    cli::cli_abort("Metadata could not be found, please check")
+  }
+
+  out
+}
+
+set_metadata <- function(data, metadata) {
+  attr(data, "metadata") <- metadata
+  data
+}
+
+inform_metadata_access <- function() {
+  cli::cli_inform(c("", "i" = "SPD metadata has been attached to the data and can be accessed via `metadata()`"))
+}
+
+inform_metadata_version <- function(version) {
+  if (version != "latest") {
+    cli::cli_warn("Metadata is based on the latest version of the data and may not be relevant to the requested data")
+  }
+}