Docs and actions

.Rbuildignore

@@ -37,3 +37,5 @@
 ^pkgdown\.yml$
 ^\.imgbotconfig$
 ^\.lintr$
+^CODE_OF_CONDUCT\.md$
+^CONTRIBUTING\.md$

.github/dependabot.yml

@@ -13,3 +13,4 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+

.github/workflows/cff-validator.yml

@@ -17,4 +17,5 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Validate CITATION.cff
-        uses: dieghernan/cff-validator@main
+        uses: dieghernan/cff-validator@main
+

.github/workflows/check-full.yaml

@@ -56,3 +56,4 @@ jobs:
           needs: check
 
       - uses: r-lib/actions/check-r-package@v2
+

.github/workflows/cran-status.yaml

@@ -8,16 +8,17 @@ on:
 jobs:
   check:
     runs-on: ubuntu-latest
-    permissions: write-all 
+    permissions: write-all
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-        
+
       - name: Check
         uses: dieghernan/cran-status-check@v1
         with:
           fail-on-error: "true"
-          create-issue: "false" 
+          create-issue: "false"
+

.github/workflows/lint.yaml

@@ -1,30 +1,71 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
-# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# lintr provides static code analysis for R.
+# It checks for adherence to a given style,
+# identifying syntax errors and possible semantic issues,
+# then reports them to you so you can take action.
+# More details at https://lintr.r-lib.org/
+
+name: lintr
+
 on:
   push:
-    branches: [main, master]
+    branches:
+      - main
+      - master
+  workflow_dispatch:
   pull_request:
-    branches: [main, master]
+    # The branches below must be a subset of the branches above
+    branches:
+      - main
+      - master
+  schedule:
+    - cron: '56 11 * * 5'
 
-name: lint
+permissions:
+  contents: read
 
 jobs:
-  lint:
+  lintr:
+    name: Run lintr scanning
     runs-on: ubuntu-latest
-    env:
-      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: read # for checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - uses: r-lib/actions/setup-r@v2
+      - name: Setup R
+        uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v2
+      - name: Setup lintr
+        uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: any::lintr
-          needs: lint
+          extra-packages: |
+            local::.
+            any::lintr
 
-      - name: Lint
-        run: lintr::lint_package()
+      - name: Run lintr
+        run: |
+          # Lintr package
+          out <- lintr::lint_package()
+          # Create SARIF report
+          lintr::sarif_output(out, "lintr-results.sarif")
+          # Display
+          out
         shell: Rscript {0}
+        continue-on-error: true
+
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: lintr-results.sarif
+          wait-for-processing: true
+

.github/workflows/pkgcheck.yaml

@@ -0,0 +1,21 @@
+name: pkgcheck
+
+# This will cancel running jobs once a new run is triggered
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+on:
+  # Manually trigger the Action under Actions/pkgcheck
+  workflow_dispatch:
+
+jobs:
+  pkgcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ropensci-review-tools/pkgcheck-action@main
+        with:
+          summary-only: false
+          post-to-issue: true
+          append-to-issue: true
+

.github/workflows/pkgdown-gh-pages-clean.yaml

@@ -40,3 +40,4 @@ jobs:
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, clean = TRUE, run_dont_run = TRUE)'
+

.github/workflows/revdepcheck.yaml

@@ -52,3 +52,4 @@ jobs:
           git add -A
           git commit -m 'revdepcheck' || echo "No changes to commit"
           git push origin || echo "No changes to commit"
+

.github/workflows/rostemplate-gh-pages.yaml

@@ -46,4 +46,4 @@ jobs:
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, run_dont_run = TRUE)'
-          
+

.github/workflows/test-coverage.yaml

@@ -13,7 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-      CURL_SSL_BACKEND: "openssl"
 
     steps:
       - uses: actions/checkout@v3
@@ -26,17 +25,16 @@ jobs:
         with:
           extra-packages: any::covr
           needs: coverage
-          cache-version: tile
 
       - name: Test coverage
-        run: | 
+        run: |
           covr::codecov(
             quiet = FALSE,
             clean = FALSE,
             install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
           )
         shell: Rscript {0}
-        
+
       - name: Show testthat output
         if: always()
         run: |
@@ -49,4 +47,5 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: coverage-test-failures
-          path: ${{ runner.temp }}/package
+          path: ${{ runner.temp }}/package
+

.github/workflows/update-docs.yaml

@@ -58,3 +58,4 @@ jobs:
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
           Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, run_dont_run = TRUE)'
+

.github/workflows/wipe-cache.yaml

@@ -8,3 +8,4 @@ jobs:
 
     steps:
       - uses: easimon/wipe-cache@main
+

.lintr

@@ -1,4 +1,3 @@
 linters: linters_with_defaults() # see vignette("lintr")
-exclusions: list(
-    "data-raw"
-  )
+encoding: "UTF-8"
+exclusions: list("data-raw")

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# CONTRIBUTING
+
+## Fixing typos
+
+Small typos or grammatical errors in documentation may be edited directly using
+the GitHub web interface, so long as the changes are made in the *source* file.
+
+-   YES ✔️: you edit a roxygen comment in a `.R` file below `R/`.
+-   NO ❌: you edit an `.Rd` file below `man/`.
+
+## Prerequisites
+
+Before you make a substantial pull request, you should always file an issue and
+make sure someone from the team agrees that it's a problem. If you've found a
+bug, create an associated issue and illustrate the bug with a minimal
+[reprex](https://www.tidyverse.org/help/#reprex).
+
+## Pull request process
+
+-   We recommend that you create a Git branch for each pull request (PR).
+-   Look at the `R-CMD-check` build status before. After making changes, run
+    `devtools::check()` and ensure no new Notes, Warnings or Errors are
+    appearing.
+-   We recommend the tidyverse [style guide](http://style.tidyverse.org). We
+    also use the [styler](https://CRAN.R-project.org/package=styler) package to
+    apply these styles, but please **don't restyle code that has nothing to do
+    with your PR**.
+-   We use [roxygen2](https://cran.r-project.org/package=roxygen2).
+-   We use [testthat](https://cran.r-project.org/package=testthat).
+    Contributions with test cases included are easier to accept.
+-   For user-facing changes, add a bullet to the top of `NEWS.md` below the
+    current development version header describing the changes made followed by
+    your GitHub username, and links to relevant issue(s)/PR(s).
+
+## Prefer to Email?
+
+Email the person listed as maintainer in the `DESCRIPTION` file of this repo.
+
+Though note that private discussions over email don't help others - of course
+email is totally warranted if it's a sensitive problem of any kind.
+
+## Thanks for contributing!
+
+This contributing guide is adapted from the tidyverse contributing guide
+available at
+<https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md>

R/addProviderEspTiles.R

@@ -2,7 +2,8 @@
 leafletprovidersESP_v <- "v1.3.3"
 
 
-#' Include base tiles of Spanish public administrations on a \pkg{leaflet} map
+#' Include base tiles of Spanish public administrations on a \CRANpkg{leaflet}
+#' map
 #'
 #' @description
 #' Include tiles of public Spanish organisms to a

R/data.R

@@ -75,7 +75,7 @@ NULL
 #' @docType data
 #'
 #' @description
-#' A \pkg{sf} object including all NUTS levels of Spain as provided by
+#' A \CRANpkg{sf} object including all NUTS levels of Spain as provided by
 #' GISCO (2016 version).
 #'
 #' @source
@@ -111,8 +111,8 @@ NULL
 #' @name esp_munic.sf
 #'
 #' @description
-#' A \pkg{sf} object including all municipalities of Spain as provided by GISCO
-#' (2019 version).
+#' A \CRANpkg{sf} object including all municipalities of Spain as provided by
+#' GISCO (2019 version).
 #'
 #' @docType data
 #'
@@ -169,7 +169,7 @@ NULL
 #' @description
 #' `r lifecycle::badge('superseded')`
 #'
-#' This data frame is not longer in use by \pkg{mapSpain}. See
+#' This data frame is not longer in use by \CRANpkg{mapSpain}. See
 #' [esp_tiles_providers] instead.
 #'
 #' A data frame containing information of different public WMS and WMTS

R/esp_cache.R

@@ -1,4 +1,4 @@
-#' Set your \pkg{mapSpain} cache dir
+#' Set your \CRANpkg{mapSpain} cache dir
 #'
 #' @family cache utilities
 #' @seealso [rappdirs::user_config_dir()]
@@ -174,8 +174,7 @@ esp_hlp_detect_cache_dir <- function() {
       cached_path <- readLines(cache_config)
 
       # Case on empty cached path - would default
-      if (is.null(cached_path) ||
-        is.na(cached_path) || cached_path == "") {
+      if (any(is.null(cached_path), is.na(cached_path), cached_path == "")) {
         cache_dir <- esp_set_cache_dir(
           overwrite = TRUE,
           verbose = FALSE

R/esp_cache_clear.R

@@ -1,4 +1,4 @@
-#' Clear your \pkg{mapSpain} cache dir
+#' Clear your \CRANpkg{mapSpain} cache dir
 #'
 #' @family cache utilities
 #'
@@ -8,21 +8,21 @@
 #' **Use this function with caution**. This function would clear your cached
 #' data and configuration, specifically:
 #'
-#' * Deletes the \pkg{mapSpain} config directory
+#' * Deletes the \CRANpkg{mapSpain} config directory
 #'   (`rappdirs::user_config_dir("mapSpain", "R")`).
 #' * Deletes the `cache_dir` directory.
 #' * Deletes the values on stored on `Sys.getenv("MAPSPAIN_CACHE_DIR")` and
 #'   `options(mapSpain_cache_dir)`.
 #'
 #' @param config if `TRUE`, will delete the configuration folder of
-#'   \pkg{mapSpain}.
+#'   \CRANpkg{mapSpain}.
 #' @param cached_data If this is set to `TRUE`, it will delete your
 #'   `cache_dir` and all its content.
 #' @inheritParams esp_set_cache_dir
 #'
 #' @details
 #' This is an overkill function that is intended to reset your status
-#' as it you would never have installed and/or used \pkg{mapSpain}.
+#' as it you would never have installed and/or used \CRANpkg{mapSpain}.
 #'
 #' @examples
 #'