align dev >> master (#90)

* clearer and more concise docs

* pipeline housekeeping

* version numbering aligned

.github/workflows/R-CMD-check.yaml

@@ -36,7 +36,7 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -54,3 +54,4 @@ jobs:
       - uses: r-lib/actions/check-r-package@v2
         with:
           upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/coverage.yaml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - uses: r-lib/actions/setup-r@v2
+      - uses: r-lib/actions/setup-r@v4
         with:
           use-public-rspm: true
 

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: RCzechia
 Type: Package
 Title: Spatial Objects of the Czech Republic
-Version: 1.12.0
-Date: 2023-10-29
+Version: 1.12.1
+Date: 2024-03-04
 Authors@R: c(
   person("Jindra", "Lacko", , "jindra.lacko@gmail.com", role = c("aut", "cre"),
          comment = c(ORCID = "0000-0002-0375-5156")),
@@ -47,7 +47,7 @@ SystemRequirements:
   GDAL (>= 2.2.3), 
   GEOS (>= 3.6.2),
   PROJ (>= 4.9.3)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 VignetteBuilder: knitr
 NeedsCompilation: no
 Roxygen: list(markdown = TRUE)

NEWS.md

@@ -1,3 +1,8 @@
+## version 1.2.1 (2024-03-04)
+
+ - documentation updated in line with current roxygen2 and pkgdown standards
+ - github actions updated to current standards
+
 ## version 1.12.0 (2023-10-29)
 
  - [!] introduced an option for persistent local caching via setting the `RCZECHIA_HOME` environment variable; this has to be set manually - either directly or via a set_home() function call

R/RCzechia.R

@@ -8,12 +8,21 @@
 #' To save time (and bandwidth) the downloaded objects are saved locally in
 #' `tempdir` directory when requested, and downloaded at most once *per R
 #' session*; out of respect to CRAN Repository Policy a more permanent caching
-#' on user's side is not attempted.
+#' on user's side is not attempted by default – but it can be actively introduced
+#' by the user either via a \code{RCzechia::set_home()} call or by setting the
+#' value of `RCZECHIA_HOME` environment variable directly, either using a
+#' \code{Sys.setenv()} call or via editing the \code{.Renviron} file.
 #'
 #' This means that:
 #' \itemize{
 #'   \item a working internet connection is required to use the full resolution objects
-#'   \item all objects need to be called with (possibly empty) braces
+#'   \item the first call to an object in a R session will download
+#'   the object from the internet (and thus take some time)
+#'   \item the user an has an option to create a permanent local cache of the objects
+#'   by setting the `RCZECHIA_HOME` environment variable in her  \code{.Renviron} file,
+#'   gaining a faster access to the objects in the future and sidestepping the
+#'   requirement of a working internet connection. Out of respect to CRAN
+#'   Repository Policy this is not default behavior.
 #' }
 #'
 #' For the most frequently used objects - **republika**, **kraje** and
@@ -98,13 +107,12 @@
 #'   \item *geocode* - geocoding (from address to coordinates)
 #'   \item *revgeo* - reverse geocoding (from coordinates to address)
 #' }
-#'
-#' @docType package
-#' @name RCzechia-package
+#' @references
+#' Lacko J (2023). “RCzechia: Spatial Objects of the Czech Republic.” Journal of Open Source Software, 8(83). doi:10.21105/joss.05082, https://joss.theoj.org/papers/10.21105/joss.05082.
 #'
 #' @import sf
 #' @importFrom httr http_error
 #' @importFrom curl curl_download
 #' @importFrom magrittr %>%
 
-NULL
+"_PACKAGE"

R/helpers.R

@@ -6,7 +6,7 @@
 #'
 #' Also note that you can set the value of RCZECHIA_HOME environment variable directly, either via a \code{Sys.setenv()} call or via your \code{.Renviron} file.
 #'
-#' @param path file to be downloaded (or not...) from S3
+#' @param path path to local filesystem directory to be used as a cache; must exist and must be writable
 #'
 #' @return TRUE for success and FALSE for failure; returned silently