Migrate to Quarto

Author: dieghernan

.Rbuildignore

@@ -41,3 +41,8 @@
 ^vignettes/\.quarto$
 ^vignettes/articles/\.quarto$
 ^vignettes/articles/*_files$
+^vignettes/*_files$
+^README\.qmd$
+^inst/README\.qmd$
+^README_files$
+^README\.html$

.github/workflows/check-full.yaml

@@ -42,7 +42,6 @@ jobs:
         - {os: ubuntu-latest, r: "4.1.0"}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
     - uses: actions/checkout@v6
@@ -58,9 +57,8 @@ jobs:
     - uses: r-lib/actions/setup-r-dependencies@v2
       with:
         extra-packages: |
+          local::.
           any::rcmdcheck
-          any::testthat
-          any::usethis
         needs: check
 
     - uses: r-lib/actions/check-r-package@v2

.github/workflows/update-docs.yaml

@@ -27,9 +27,25 @@ jobs:
       with:
         extra-packages: |
           local::.
+          any::rcmdcheck
           dieghernan/pkgdev
         needs: website
 
+    - name: Install optipng
+      run: |
+        if [ "$RUNNER_OS" == "Linux" ]; then
+          sudo apt-get update
+          sudo apt-get install optipng
+        elif [ "$RUNNER_OS" == "Windows" ]; then
+          choco install optipng
+        elif [ "$RUNNER_OS" == "macOS" ]; then
+          brew install optipng
+        else
+          echo "$RUNNER_OS not supported"
+          exit 1
+        fi
+      shell: bash
+
     - name: Run jarl
       uses: etiennebacher/setup-jarl@v0.1.0
       continue-on-error: true
@@ -45,7 +61,7 @@ jobs:
     - name: Update docs
       run: |
         
-        pkgdev::update_docs(opt_dir = c("man/figures", "img", "vignettes"))
+        pkgdev::update_docs()
 
       shell: Rscript {0}
 

.gitignore

@@ -33,3 +33,6 @@ CRAN-SUBMISSION
 Rplots.pdf
 /.quarto/
 **/*.quarto_ipynb
+**/.quarto/
+README_files/
+README.html

CITATION.cff

@@ -230,6 +230,23 @@ references:
     orcid: https://orcid.org/0000-0003-4757-117X
   year: '2026'
   doi: 10.32614/CRAN.package.lifecycle
+- type: software
+  title: quarto
+  abstract: 'quarto: R Interface to ''Quarto'' Markdown Publishing System'
+  notes: Suggests
+  url: https://quarto-dev.github.io/quarto-r/
+  repository: https://CRAN.R-project.org/package=quarto
+  authors:
+  - family-names: Allaire
+    given-names: JJ
+    email: jj@posit.co
+    orcid: https://orcid.org/0000-0003-0174-9868
+  - family-names: Dervieux
+    given-names: Christophe
+    email: cderv@posit.co
+    orcid: https://orcid.org/0000-0003-4474-2498
+  year: '2026'
+  doi: 10.32614/CRAN.package.quarto
 - type: software
   title: rmarkdown
   abstract: 'rmarkdown: Dynamic Documents for R'

DESCRIPTION

@@ -28,11 +28,13 @@ Suggests:
     bibtex (>= 0.5.0),
     knitr,
     lifecycle,
+    quarto,
     rmarkdown,
     testthat (>= 3.0.0),
     usethis
 VignetteBuilder: 
-    knitr
+    knitr,
+    quarto
 Config/Needs/website: devtools
 Config/testthat/edition: 3
 Config/testthat/parallel: true

NEWS.md

@@ -1,6 +1,7 @@
 # cffr (development version)
 
 -   Minimum **R** version required now is **4.1.0**.
+-   Migrate vignettes to Quarto.
 
 # cffr 1.2.1
 

R/as_bibentry.R

@@ -61,15 +61,13 @@
 #' @family bibtex
 #' @family s3method
 #'
-#'
 #' @details
 #'
 #' A **R** `bibentry` object is the representation of a BibTeX entry. These
 #' objects can be converted to BibTeX markup with [toBibtex()], that creates an
 #' object of class `Bibtex` and can be printed and exported as a valid BibTeX
 #' entry.
 #'
-#'
 #' `as_bibtex()` tries to map the information of the source `x` into a `cff]
 #' object and performs a mapping of the metadata to BibTeX, according to
 #' `vignette("bibtex_cff", "cffr")`.
@@ -112,7 +110,6 @@
 #'
 #' installed_package
 #'
-#'
 #' # Use a DESCRIPTION file
 #' path2 <- system.file("examples/DESCRIPTION_gitlab", package = "cffr")
 #' desc_file <- as_bibentry(path2)

R/as_cff.R

@@ -157,7 +157,6 @@ as.cff <- function(x) {
 
 #' Recursively clean lists
 #'
-#'
 #' @noRd
 rapply_drop_null <- function(x) {
   if (is.list(x) && length(x) > 0) {

R/as_cff_person.R

@@ -10,7 +10,6 @@
 #'            "(https://github.com/citation-file-format/",
 #'            "citation-file-format/blob/main/schema-guide.md)."))
 #'
-#'
 #' ```
 #'
 #' `as_cff_person` is an S3 generic, with methods for:
@@ -48,12 +47,10 @@
 #'            "(https://github.com/citation-file-format/",
 #'            "citation-file-format/blob/main/schema-guide.md). "))
 #'
-#'
 #' ```
 #' Each element of the `cff_pers_lst` object would have classes
 #' [`cff_pers, cff`][cff_pers].
 #'
-#'
 #' @details
 #'
 #' `as_cff_person()` would recognize if the input should be converted using the
@@ -100,7 +97,6 @@
 #'
 #' See **Examples** for more information.
 #'
-#'
 #' @examples
 #' # Create a person object
 #' a_person <- person(
@@ -151,7 +147,6 @@
 #' # Or as person object
 #' as.person(a_cff)
 #'
-#'
 #' # Or you can use BibTeX style as input if you prefer
 #'
 #' x <- "Frank Sinatra and Dean Martin and Davis, Jr., Sammy and Joey Bishop"