Update workflows and documentation for version 0.2.0.9000; add quarto setup and improve error handling in tests

Author: e-kotov

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

@@ -16,14 +16,16 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
       _R_CHECK_RD_VALIDATE_RD2HTML_: TRUE
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Install pdflatex
         run: sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
 
       - name: Install tidy
         run: sudo apt install tidy
 
+      - uses: quarto-dev/quarto-actions/setup@v2
+
       - uses: r-lib/actions/setup-r@v2
         with:
           r-version: 'devel'

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

@@ -35,6 +35,8 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@v2
 
+      - uses: quarto-dev/quarto-actions/setup@v2
+
       - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}

.github/workflows/pkgdown.yaml

@@ -28,6 +28,8 @@ jobs:
 
       - uses: r-lib/actions/setup-pandoc@v2
 
+      - uses: quarto-dev/quarto-actions/setup@v2
+
       - uses: r-lib/actions/setup-r@v2
         with:
           use-public-rspm: true

CITATION.cff

@@ -9,7 +9,7 @@ type: software
 license: MIT
 title: 'rdocdump: Dump ''R'' Package Source, Documentation, and Vignettes into One
   File'
-version: 0.2.0
+version: 0.2.0.9000
 doi: 10.32614/CRAN.package.rdocdump
 identifiers:
 - type: doi

R/set_cache_path.R

@@ -1,11 +1,12 @@
 #' Set `rdocdump` Cache Path in the Current R Session
 #'
 #' @description
-#' This function sets the cache path used by `rdocdump` to store temporary files
-#' (downloaded tar.gz archives and/or extracted directories) for the current R
-#' session. The cache path is stored in the option `"rdocdump.cache_path"`, which
-#' can be checked with `getOption("rdocdump.cache_path")`. The path is created if
-#' it does not exist.
+#' This function sets the cache path used by `rdocdump` to store temporary
+#' files (downloaded tar.gz archives and/or extracted directories) for the
+#' current R session. The cache path is stored in the option
+#' `"rdocdump.cache_path"`, which can be checked with
+#' `getOption("rdocdump.cache_path")`. The path is created if it does not
+#' exist.
 #'
 #' @param path A `character` string specifying the directory to be used as the
 #'   cache path.

R/to_txt.R

@@ -76,11 +76,12 @@
 #' @export
 #'
 #' @examples
-#' # Extract documentation for built-in `stats` package (both docs and vignettes).
+#' # Extract documentation for built-in `stats` package (both docs and
+#' # vignettes).
 #' docs <- rdd_to_txt("splines")
 #' cat(substr(docs, 1, 500))
 #'
-#' \dontrun{
+#' \donttest{
 #' # Extract from GitHub repository
 #' docs <- rdd_to_txt("r-lib/rlang")
 #'
@@ -125,7 +126,10 @@ rdd_to_txt <- function(
   # Validate keep_files argument.
   if (!keep_files %in% c("none", "tgz", "extracted", "both")) {
     stop(
-      'Invalid value for keep_files. Choose one of "none", "tgz", "extracted", "both".'
+      paste(
+        'Invalid value for keep_files.',
+        'Choose one of "none", "tgz", "extracted", "both".'
+      )
     )
   }
 
@@ -179,7 +183,8 @@ rdd_to_txt <- function(
       force_fetch = force_fetch || !is.null(version),
       version = version,
       cache_path = cache_path,
-      keep_files = "both" # make sure the files are not deleted prematurely, as rdd_to_txt will take care of that later
+      keep_files = "both" # make sure files are not deleted prematurely,
+                          # as rdd_to_txt will take care of that later
     )
   }
 

R/util_resolve_pkg_path.R

@@ -137,7 +137,8 @@ resolve_pkg_path <- function(
       ) {
         warning(
           "Using a repository URL from posit.co or r-universe.dev may result ",
-          "in pre-built binaries being downloaded instead of the package source."
+          "in pre-built binaries being downloaded instead of the package ",
+          "source."
         )
       }
 
@@ -251,7 +252,9 @@ is_binary_pkg <- function(pkg_dir) {
   }
 
   has_help_binaries <- if (dir.exists(help_dir)) {
-    length(list.files(help_dir, pattern = "\\.(rdx|rdb)$", ignore.case = TRUE)) > 0
+    length(
+      list.files(help_dir, pattern = "\\.(rdx|rdb)$", ignore.case = TRUE)
+    ) > 0
   } else {
     FALSE
   }

R/util_resolve_remote.R

@@ -32,7 +32,8 @@ resolve_remote_pkg <- function(pkg_ref, cache_path = NULL) {
   # Check if remotes package is installed
   if (!requireNamespace("remotes", quietly = TRUE)) {
     stop(
-      "The 'remotes' package is required to download from remote repositories. ",
+      "The 'remotes' package is required to download from remote ",
+      "repositories. ",
       "Please install it with: install.packages('remotes')"
     )
   }

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/e-kotov/rdocdump",
   "issueTracker": "https://github.com/e-kotov/rdocdump/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.2.0",
+  "version": "0.2.0.9000",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -115,7 +115,7 @@
   "softwareRequirements": {
     "SystemRequirements": null
   },
-  "fileSize": "278.121KB",
+  "fileSize": "289.194KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",
@@ -139,6 +139,6 @@
   "releaseNotes": "https://github.com/e-kotov/rdocdump/blob/main/NEWS.md",
   "readme": "https://github.com/e-kotov/rdocdump/blob/main/README.md",
   "contIntegration": ["https://github.com/e-kotov/rdocdump/actions/workflows/R-CMD-check.yaml", "https://github.com/e-kotov/rdocdump/actions?query=workflow%3Apkgcheck"],
-  "developmentStatus": ["https://www.repostatus.org/#active", "https://lifecycle.r-lib.org/articles/stages.html#experimental"],
+  "developmentStatus": ["https://www.repostatus.org/#active", "https://lifecycle.r-lib.org/articles/stages.html#stable"],
   "keywords": ["llm", "r-package", "rag", "text"]
 }