Update devel after initial cran release (#80)

aleksanderbl29 · Oct 31, 2024 · 6936441 · 6936441
2 parents a2fe063 + bce6f6e
commit 6936441
Show file tree

Hide file tree

Showing 24 changed files with 2,006 additions and 2,280 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -47,6 +47,7 @@ repos:
           \.github/workflows/.*|
           data/.*|
           renv/.*|
+          CRAN-SUBMISSION|
           )$
     -   id: lintr
     -   id: readme-rmd-rendered

diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 0.2.3
+Date: 2024-10-28 12:44:43 UTC
+SHA: 5a8f038bf1e2d06a9176448f50ae4ef7bc40076e
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,15 +1,16 @@
 Package: dawaR
-Title: An API Wrapper Package for DAWA - The Danish Address Web API
-Date: 2024-10-23
+Title: An API Wrapper for 'DAWA' - 'The Danish Address Web API'
+Date: 2024-10-28
 Version: 0.2.3
 Authors@R: 
     person("Aleksander", "Bang-Larsen", , "[email protected]",
            role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0009-0007-7984-4650"))
-Description: Package providing functions to interact with all sections of
-    the official Danish Address Web API (also known as DAWA). The development
-    of this package is completely independent from the 
-    [government entity that maintains the API](sdfi.dk).
+Description: Functions for interacting with all sections of
+    the official 'Danish Address Web API' (also known as 'DAWA') 
+    <https://api.dataforsyningen.dk>. The development of this package is
+    completely independent from the government agency, Klimadatastyrelsen,
+    who maintains the API.
 License: GPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

diff --git a/NAMESPACE b/NAMESPACE
@@ -8,5 +8,4 @@ export(get_map_data)
 export(reverse)
 export(status_check)
 importFrom(rlang,list2)
-importFrom(rlang,splice)
 importFrom(tidyRSS,tidyfeed)
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# dawaR 0.2.3
+# dawaR 0.2.3 (2024-10-23)
 
 * Initial CRAN submission.
 * Add package startup message

diff --git a/R/get_map_data.R b/R/get_map_data.R
@@ -19,9 +19,11 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' x <- get_map_data("regioner")
 #' ggplot2::ggplot(x) +
 #'   ggplot2::geom_sf()
+#' }
 get_map_data <- function(type, cache = TRUE, ...) {
   params <- rlang::list2(...)
 
@@ -37,12 +39,12 @@ get_map_data <- function(type, cache = TRUE, ...) {
   }
 }
 
-#' @importFrom rlang splice list2
+#' @importFrom rlang list2
 get_map_data_w_cache <- memoise::memoise(function(type, params = list()) {
   get_map_data_nocache(type = type, cache = TRUE, params = params)
 })
 
-#' @importFrom rlang splice list2
+#' @importFrom rlang list2
 get_map_data_nocache <- function(type, cache = FALSE, params = list()) {
   if (!type %in% available_sections(format = "geojson", verbose = FALSE)) {
     cli::cli_abort("You have provided type {.var {type}}

diff --git a/R/status_check.R b/R/status_check.R
@@ -1,9 +1,9 @@
 #' Check that all DAWA services are operational
 #'
 #' @description This function fetches the status of all available SDFI services.
-#'   This package depends on at least one of these. It checks [this status
-#'   url](https://erdataforsyningennede.site24x7statusiq.com/). The status can
-#'   also be followed on the official [X-page](https://x.com/DriftDataforsyn).
+#'   This package depends on at least one of these. It checks the official
+#'   status page. The status can also be followed on their official X-page
+#'   `@DriftDataforsyn`.
 #'
 #'
 #' @param return_df This option makes the function return a data.frame object

diff --git a/R/utils.R b/R/utils.R
@@ -1,9 +1,3 @@
-# onAttach ----
-.onAttach <- function(...) {
-  get_status_message() |>
-    packageStartupMessage()
-}
-
 # nolint start
 get_status_message <- function() {
   httr2::request("https://raw.githubusercontent.com/aleksanderbl29/dawaR/refs/heads/main/status-message") |>

diff --git a/README.Rmd b/README.Rmd
@@ -71,7 +71,7 @@ If you install the package in an environment configured with [`renv`](https://rs
 
 ## Usage
 
-Be sure to see the [getting started](articles/dawaR.html) and the [guide on how to make maps with {dawaR}](articles//printing_maps.html).
+Be sure to see the [getting started](https://dawar.aleksanderbl.dk/articles/dawaR.html) and the [guide on how to make maps with {dawaR}](https://dawar.aleksanderbl.dk/articles/printing_maps.html).
 
 ## DAWA *will* be phased out
 

diff --git a/README.md b/README.md
@@ -48,8 +48,10 @@ as intended.
 
 ## Usage
 
-Be sure to see the [getting started](articles/dawaR.html) and the [guide
-on how to make maps with {dawaR}](articles//printing_maps.html).
+Be sure to see the [getting
+started](https://dawar.aleksanderbl.dk/articles/dawaR.html) and the
+[guide on how to make maps with
+{dawaR}](https://dawar.aleksanderbl.dk/articles/printing_maps.html).
 
 ## DAWA *will* be phased out
 

diff --git a/codemeta.json b/codemeta.json
diff --git a/cran-comments.md b/cran-comments.md
@@ -3,3 +3,9 @@
 0 errors | 0 warnings | 1 note
 
 * This is a new release.
+* Fixed test that fails sporadically. - Resubmission
+
+Addressed comments from Konstanze Lauseker on 28/10/24.
+
+* Added single quotes around API-names in DESCRIPTION title and description
+* Added web reference for the API.