Merge pull request #118 from rOpenSpain/fix-examples-for-r-cmd-check

PR to test if R CMD check is happy when data downloading examples are conditional on interactive session
rOpenSpain · Dec 17, 2024 · cf5bcd9 · cf5bcd9
2 parents a8612d7 + 459d230
commit cf5bcd9
Show file tree

Hide file tree

Showing 21 changed files with 30 additions and 19 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -49,4 +49,4 @@ jobs:
       - uses: r-lib/actions/check-r-package@v2
         with:
           upload-snapshots: true
-          build_args: 'c("--no-manual", "--compact-vignettes=gs+qpdf", "--no-examples")'
+          build_args: 'c("--no-manual", "--compact-vignettes=gs+qpdf")'
diff --git a/R/available-data.R b/R/available-data.R
@@ -16,7 +16,7 @@
 #'   \item{downloaded}{\code{logical}. Indicator of whether the data file has been downloaded locally. This is only available if `check_local_files` is `TRUE`.}
 #' }
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' 
 #' # Set data dir for file downloads

diff --git a/R/connect.R b/R/connect.R
@@ -11,7 +11,7 @@
 #' @export
 #' @return a `DuckDB` table connection object.
 #' 
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' # Set data dir for file downloads
 #' spod_set_data_dir(tempdir())

diff --git a/R/convert.R b/R/convert.R
@@ -24,7 +24,7 @@
 #' @return Path to saved `DuckDB` database file or to a folder with `parquet` files in hive-style directory structure.
 #' @export
 #' 
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' # Set data dir for file downloads
 #' spod_set_data_dir(tempdir())

diff --git a/R/data-dir.R b/R/data-dir.R
@@ -59,6 +59,7 @@ spod_set_data_dir <- function(
 #' @return A `character` vector of length 1 containing the path to the data directory where the package will download and convert the data.
 #' @export
 #' @examples
+#' spod_set_data_dir(tempdir())
 #' spod_get_data_dir()
 #' 
 spod_get_data_dir <- function(quiet = FALSE) {

diff --git a/R/disconnect.R b/R/disconnect.R
@@ -6,7 +6,7 @@
 #' @param free_mem A `logical`. Whether to free up memory by running `gc()`. Defaults to `TRUE`.
 #' @return No return value, called for side effect of disconnecting from the database and freeing up memory.
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' # Set data dir for file downloads
 #' spod_set_data_dir(tempdir())

diff --git a/R/download_data.R b/R/download_data.R
@@ -13,7 +13,7 @@
 #' @return Nothing. If `return_local_file_paths = TRUE`, a `character` vector of the paths to the downloaded files.
 #'
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' 
 #' # Set data dir for file downloads

diff --git a/R/get-zones.R b/R/get-zones.R
@@ -33,7 +33,7 @@
 #' }
 #' 
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' # get polygons for municipalities for the v2 data
 #' municip_v2 <- spod_get_zones(zones = "municipalities", ver = 2)

diff --git a/R/get.R b/R/get.R
@@ -13,7 +13,7 @@
 #' @inheritParams global_quiet_param
 #' @return A DuckDB lazy table connection object of class `tbl_duckdb_connection`.
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' 
 #' # create a connection to the v1 data

diff --git a/R/internal-utils.R b/R/internal-utils.R
@@ -229,7 +229,7 @@ spod_expand_dates_from_regex <- function(date_regex) {
 #' @inheritParams spod_available_data
 #' @return A vector of type `Date` with all possible valid dates for the specified data version (v1 for 2020-2021 and v2 for 2020 onwards).
 #' @export
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' # Get all valid dates for v1 (2020-2021) data
 #' spod_get_valid_dates(ver = 1)

diff --git a/R/quick-get.R b/R/quick-get.R
@@ -20,7 +20,7 @@
 #' 
 #' @export
 #' 
-#' @examples
+#' @examplesIf interactive()
 #' \donttest{
 #' od_1000 <- spod_quick_get_od(
 #'   date = "2022-01-01",

diff --git a/man/spod_available_data.Rd b/man/spod_available_data.Rd
diff --git a/man/spod_connect.Rd b/man/spod_connect.Rd
diff --git a/man/spod_convert.Rd b/man/spod_convert.Rd
diff --git a/man/spod_disconnect.Rd b/man/spod_disconnect.Rd
diff --git a/man/spod_download.Rd b/man/spod_download.Rd
diff --git a/man/spod_get.Rd b/man/spod_get.Rd
diff --git a/man/spod_get_data_dir.Rd b/man/spod_get_data_dir.Rd
diff --git a/man/spod_get_valid_dates.Rd b/man/spod_get_valid_dates.Rd
diff --git a/man/spod_get_zones.Rd b/man/spod_get_zones.Rd
diff --git a/man/spod_quick_get_od.Rd b/man/spod_quick_get_od.Rd