Add data retrieval functions and make pacakge pass checks

Author: aleksanderbl29

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: geodk
 Title: Access Danish Geospatial Data
-Version: 0.0.0.9000
-Date: 2024-11-25
+Version: 0.0.0.9001
+Date: 2025-03-10
 Authors@R: c(
     person("Aleksander", "Bang-Larsen", , "contact@aleksanderbl.dk",
             role = c("aut", "cre", "cph"), 
@@ -42,8 +42,6 @@ Remotes:
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Encoding: UTF-8
-LazyData: true
-LazyDataCompression: xz
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
 X-schema.org-isPartOf: http://ropengov.org/

NAMESPACE

@@ -2,11 +2,17 @@
 
 S3method(geodk_enrich,default)
 S3method(geodk_enrich,dkstat_Denmark_municipality_07)
+export(constituencies)
 export(geodk_enrich)
+export(get_geo)
 export(get_levels)
+export(municipalities)
+export(parishes)
 export(plot_denmark)
 export(plot_municipalities)
 export(plot_regions)
+export(prefill_cache)
+export(regions)
 importFrom(ggplot2,aes)
 importFrom(ggplot2,geom_sf)
 importFrom(ggplot2,ggplot)

NEWS.md

@@ -0,0 +1,6 @@
+# geodk 0.0.0.9001
+
+* Cached datasets have been removed.
+  * The function `prefill_chache()` have been added.
+* Added data retrieval functions.
+* Implemented first class for dkstat integration. Datasets with class `dkstat_Denmark_municipality_07` should now work with `geodk_enrich()`.

R/data.R

@@ -9,6 +9,7 @@
 #'
 #'
 #' @param x Dataframe. Preferably from `{dkstat}`
+#' @importFrom rlang .data
 #'
 #' @returns Returns a dataframe of the dimensions `cols +1 by rows`.
 #' @export
@@ -19,11 +20,17 @@ geodk_enrich <- function(x) {
 
 #' @export
 geodk_enrich.default <- function(x) {
-  cli::cli_abort("Only output from dkstat is supported at the moment")
+  cli::cli_abort(
+    c(
+      "Only output from dkstat is supported at the moment.",
+      "If you have provided output from dkstat and it still does not work,",
+      "please submit an issue on {.url {'https://github.com/rOpenGov/geodk/issues'}}"
+    )
+  )
 }
 
 #' @export
-geodk_enrich.dkstat_kom_omraade <- function(x) {
+geodk_enrich.dkstat_Denmark_municipality_07 <- function(x) {
 
   # List groupings
   hele_landet <- "000 Hele landet"
@@ -38,32 +45,32 @@ geodk_enrich.dkstat_kom_omraade <- function(x) {
   cli::cli_inform(c("i" = "Getting municipality geometries."))
   # Get sf geometries for individual municipalities
   individuals_sf <- dawaR::get_map_data("kommuner", verbose = FALSE) |>
-    dplyr::select(navn)
+    dplyr::select(.data$navn)
 
   cli::cli_inform(c("i" = "Assigning geometries to individual municipalities."))
   # Split individual observations and merge with geometries
   individuals <- x |>
-    dplyr::filter(!KOMGRP %in% c(hele_landet, groups)) |>
-    dplyr::mutate(navn = substr(KOMGRP, 5, nchar(KOMGRP))) |>
+    dplyr::filter(!.data$KOMGRP %in% c(hele_landet, groups)) |>
+    dplyr::mutate(navn = substr(.data$KOMGRP, 5, nchar(.data$KOMGRP))) |>
     dplyr::left_join(individuals_sf, by = dplyr::join_by(navn)) |>
-    dplyr::select(-navn) |>
+    dplyr::select(-.data$navn) |>
     sf::st_as_sf(crs = sf::st_crs(individuals_sf))
 
   cli::cli_inform(c("i" = "Drawing geometries for municipality groupings."))
   # Group municipality geometries to their groupings and return sf geometries
   groupings_sf <- individuals |>
     dplyr::left_join(komgrp, by = c("KOMGRP" = "name")) |>
     stats::na.omit() |>
-    dplyr::select(level, geometry) |>
+    dplyr::select(.data$level, .data$geometry) |>
     unique() |>
     sf::st_as_sf(crs = sf::st_crs(individuals_sf)) |> #sf::st_union()
-    dplyr::group_by(level) |>
+    dplyr::group_by(.data$level) |>
     dplyr::summarise() # This uses the summarise method for sf objects.
 
   cli::cli_inform(c("i" = "Assigning geometries to municipality groupings."))
   # Filter out groupings and merge with their geometries
   groupings <- x |>
-    dplyr::filter(KOMGRP %in% groups) |>
+    dplyr::filter(.data$KOMGRP %in% groups) |>
     dplyr::left_join(groupings_sf, by = c("KOMGRP" = "level")) |>
     sf::st_as_sf(crs = sf::st_crs(groupings_sf))
 
@@ -75,15 +82,15 @@ geodk_enrich.dkstat_kom_omraade <- function(x) {
         sf::st_union(),
       nrow(
         x |>
-          dplyr::filter(KOMGRP %in% hele_landet)
+          dplyr::filter(.data$KOMGRP %in% hele_landet)
         )
       )
   )
 
   cli::cli_inform(c("i" = "Assigning geometry to entire Denmark."))
   # Merge data with geometries
   denmark <- x |>
-    dplyr::filter(KOMGRP %in% hele_landet) |>
+    dplyr::filter(.data$KOMGRP %in% hele_landet) |>
     sf::st_sf(geometry = dk_sf)
 
   cli::cli_inform(c("i" = "Merging data."))
@@ -94,12 +101,13 @@ geodk_enrich.dkstat_kom_omraade <- function(x) {
     individuals
   )
 
-  cli::cli_inform(c("i" = "Assigning the proper class."))
+  # cli::cli_inform(c("i" = "Assigning the proper class."))
   # Return data.frame - Essentially strips all other classes
   # structure(
   #   out,
   #   class = "data.frame"
   # )
   class(out) <- "data.frame"
-}
 
+  out
+}

R/geodk_enrich.R

@@ -0,0 +1,43 @@
+#' Prefill data retrieval cache
+#'
+#' @param specific_section Enter a seciton name (or vector of section names) you
+#'   would like to have pre-filled. Options can be found in
+#'   `dawaR::avaialable_sections()`
+#' @description This function prefills the cache of the underlying API-function.
+#'   By default the sections shown in the example below is prefilled. This is
+#'   meant to replace the cached dataset that once was in the package. It may be
+#'   useful to prefill the cache before using `geodk_enrich`.
+#'
+#' @returns Returns nothing. Is called for the side effect of prefilling the
+#'   cache.
+#' @export
+#'
+#' @examples
+#' sections <- c(
+#'   "regioner",
+#'   "kommuner",
+#'   "postnumre",
+#'   "sogne",
+#'   "regioner",
+#'   "opstillingskredse",
+#'   "afstemningsomraader"
+#' )
+prefill_cache <- function(specific_section = NULL) {
+  sections <- c(
+    "regioner",
+    "kommuner",
+    "postnumre",
+    "sogne",
+    "regioner",
+    "opstillingskredse",
+    "afstemningsomraader",
+    specific_section
+  )
+
+  cli::cli_inform("This will prefill the cache for {sections}")
+
+  for (section in sections) {
+    dawaR::get_map_data(section, cache = TRUE) |>
+      invisible()
+  }
+}

R/prefill_cache.R

@@ -0,0 +1,106 @@
+#' Get regions
+#'
+#' @returns Returns a `{sf}` object for the danish regions
+#' @importFrom rlang .data
+#' @export
+#' @family data retrieval
+regions <- function() {
+  dawaR::get_map_data("regioner") |>
+    dplyr::rename(code = .data$kode,
+                  name = .data$navn,
+                  visualcenter_x = .data$visueltcenter_x,
+                  visualcenter_y = .data$visueltcenter_y) |>
+    dplyr::select(
+      .data$code,
+      .data$name,
+      .data$visualcenter_x,
+      .data$visualcenter_y
+    )
+}
+
+#' Get municipalities
+#'
+#' @returns Returns a `{sf}` object for the danish municipalities
+#' @importFrom rlang .data
+#' @export
+#' @family data retrieval
+municipalities <- function() {
+  dawaR::get_map_data("kommuner") |>
+    dplyr::rename(code = .data$kode,
+                  name = .data$navn,
+                  region_code = .data$regionskode,
+                  region_name = .data$regionsnavn,
+                  visualcenter_x = .data$visueltcenter_x,
+                  visualcenter_y = .data$visueltcenter_y) |>
+    dplyr::select(
+      .data$code,
+      .data$name,
+      .data$region_code,
+      .data$region_name,
+      .data$visualcenter_x,
+      .data$visualcenter_y
+    )
+}
+
+#' Get parishes
+#'
+#' @returns Returns a `{sf}` object for the danish parishes
+#' @importFrom rlang .data
+#' @export
+#' @family data retrieval
+parishes <- function() {
+  dawaR::get_map_data("sogne") |>
+    dplyr::rename(code = .data$kode,
+                  name = .data$navn,
+                  visualcenter_x = .data$visueltcenter_x,
+                  visualcenter_y = .data$visueltcenter_y) |>
+    dplyr::select(.data$code,
+                  .data$name,
+                  .data$visualcenter_x,
+                  .data$visualcenter_y)
+}
+
+#' Get constituencies
+#'
+#' @returns Returns a `{sf}` object for the danish constituencies
+#' @importFrom rlang .data
+#' @export
+#' @family data retrieval
+constituencies <- function() {
+  dawaR::get_map_data("afstemningsomraader") |>
+    dplyr::rename(code = .data$nummer,
+                  name = .data$navn,
+                  placename = .data$afstemningsstedsnavn,
+                  address = .data$afstemningsstedadressebetegnelse,
+                  address_access_x = .data$afstemningssted_adgangspunkt_x,
+                  address_access_y = .data$afstemningssted_adgangspunkt_y,
+                  municipality = .data$kommunenavn,
+                  region = .data$regionsnavn,
+                  visualcenter_x = .data$visueltcenter_x,
+                  visualcenter_y = .data$visueltcenter_y) |>
+    dplyr::select(
+      .data$code,
+      .data$name,
+      .data$placename,
+      .data$address,
+      .data$address_access_x,
+      .data$address_access_y,
+      .data$municipality,
+      .data$region,
+      .data$visualcenter_x,
+      .data$visualcenter_y
+    )
+}
+
+#' Get geogrpahies
+#'
+#' @returns Returns a `{sf}` object for the specified geography
+#'
+#' @param section The geographic level wanted.
+#'
+#' @export
+#' @family data retrieval
+get_geo <- function(section = "postnumre") {
+  dawaR::get_map_data(section)
+}
+

R/retrieval.R

@@ -67,10 +67,29 @@ devtools::install_github("rOpenGov/geodk")
 
 ## Functions
 
-`{geodk}` provides to main sets of functions:
+`{geodk}` provides three main sets of functions:
 
 - Data retrieval
 - Plotting
+- Enrichment of statistical data from `{dkstat}`
+
+### Data retrieval
+
+The package contains a few functions for retrieving data.
+
+```{r eval=FALSE}
+regions()
+municipalities()
+parishes()
+constituencies()
+```
+
+The geographic levels not included in their own functions can be accessed through `get_geo()`.
+
+```{r eval=FALSE}
+get_geo()
+prefill_cache()
+```
 
 ### Plotting
 
@@ -93,3 +112,13 @@ municipality <- plot_municipalities(municipality = c("Aarhus", "Favrskov", "Vejl
 library(patchwork)
 region + municipality
 ```
+
+### Enrichment of statistical data from `{dkstat}`
+
+The function `geodk_enrich()` enables you to add appropriate geographic information to statistical descriptions from the `{dkstat}` package.
+
+```{r eval=FALSE}
+dkstat::dst_get_all_data("laby01") |> 
+  geodk::geodk_enrich()
+```
+