Update pkgdown

NEWS.md

@@ -15,15 +15,15 @@ old API [has been
 deprecated](https://lifecycle.r-lib.org/articles/stages.html#deprecated) and it
 would warn when used, providing advice on the replacement function.
 
-#### Deprecations
+#### Deprecation
 
 -   `cff_to_bibtex()` and `cff_extract_to_bibtex()`: replaced by
     `as_bibentry()`.
 -   `cff_from_bibtex()`: replaced by `cff_read_bib()` (for `*.bib` files) and
     `cff_read_bib_text()` (for character strings).
 -   `write_bib()` and `write_citation()` : replaced by `cff_write_bib()` and
     `cff_write_citation()` respectively.
--   `cff_parse_person()` and `cff_parse_person_bibtex()`: replacedy by
+-   `cff_parse_person()` and `cff_parse_person_bibtex()`: replaced by
     `as_cff_person()`.
 -   The conversion from `cff` to `bibentry` is performed now by a new function
     `as_bibentry()`. Previous names of this function were `cff_to_bibtex()` and
@@ -56,7 +56,7 @@ would warn when used, providing advice on the replacement function.
     -   `head.cff()`, `tail.cff()`.
     -   `toBibtex.cff()`.
 -   Update of BibTeX crosswalk (see `vignette("bibtex_cff", package = "cffr")`)
-    and consecuently changes in the mapping performed by `as_bibtex()`
+    and consequently changes in the mapping performed by `as_bibtex()`
     `cff_parse_citation()`:
     -   **\@inbook** and **\@book** gains a new value on [CFF]{.underline} when
         **series** is provided: [collection-type: book-series.]{.underline}

R/cff_create.R

@@ -43,8 +43,8 @@
 #'
 #'
 #' ```
-#'
-#' `vignette("cffr", "cffr")`
+#' See also [cff_write()] for creating a CFF file. `vignette("cffr", "cffr")`
+#' shows an introduction on how manipulate `cff` objects.
 #'
 #' @details
 #'

R/cff_parse_citation.R

@@ -6,7 +6,7 @@
 #'
 #' @export
 #'
-#' @family parsers
+#' @family coercing
 #'
 #' @param bib A `bibentry` object, either created with [bibentry()]
 #'   (preferred) or [citEntry()].

R/cff_write.R

@@ -10,8 +10,7 @@
 #' [`cff`][cff-class] object and writes it out to a YAML-formatted file in
 #' one command.
 #'
-#' @family core
-#' @family write
+#' @family writing
 #'
 #' @param x The source that would be used for generating
 #'   the `CITATION.cff` file. It could be:
@@ -50,6 +49,9 @@
 #'
 #'
 #' ```
+#' This function unifies the workflow [cff_create()] + [cff_write()] +
+#' [cff_validate()].
+#'
 #' @examples
 #' \donttest{
 #' tmpfile <- tempfile(fileext = ".cff")

R/cff_write_misc.R

@@ -23,7 +23,7 @@
 #' @export
 #' @rdname cff_write_misc
 #' @family bibtex
-#' @family write
+#' @family writing
 #'
 #' @return
 #' Writes the corresponding file specified on the `file` parameter.

R/data.R

@@ -4,6 +4,8 @@
 #' on CRAN packages and its (approximate) match on the
 #' [SPDX License List](https://spdx.org/licenses/).
 #'
+#' @family datasets
+#'
 #' @format A data frame with `r nrow(cran_to_spdx)` rows and 2 variables:
 #'
 #'  * `r names(cran_to_spdx)[1]`: A valid `License` string on CRAN.

R/docs.R

@@ -4,8 +4,14 @@
 #' @aliases cff_class
 #' @keywords internal
 #'
+#' @family s3method
+#'
 #' @description
 #'
 #' ```{r child = "man/chunks/cffclass.Rmd"}
 #' ```
+#'
+#' @seealso
+#'
+#' `vignette("cffr", "cffr")` for a hands-on example.
 NULL

README.md

@@ -561,6 +561,26 @@ test <- cff_create("rmarkdown")
       - family-names: Chirico.
         given-names: Michael
       year: '2024'
+    - type: software
+      title: dygraphs
+      abstract: 'dygraphs: Interface to ''Dygraphs'' Interactive Time Series Charting
+        Library'
+      notes: Suggests
+      url: https://github.com/rstudio/dygraphs
+      repository: https://CRAN.R-project.org/package=dygraphs
+      authors:
+      - family-names: Vanderkam
+        given-names: Dan
+        website: http://dygraphs.com/
+      - family-names: Allaire
+        given-names: JJ
+      - family-names: Owen
+        given-names: Jonathan
+      - family-names: Gromer
+        given-names: Daniel
+      - family-names: Thieurmel
+        given-names: Benoit
+      year: '2024'
     - type: software
       title: fs
       abstract: 'fs: Cross-Platform File System Operations Based on ''libuv'''
@@ -577,6 +597,26 @@ test <- cff_create("rmarkdown")
         given-names: Gábor
         email: [email protected]
       year: '2024'
+    - type: software
+      title: rsconnect
+      abstract: 'rsconnect: Deploy Docs, Apps, and APIs to ''Posit Connect'', ''shinyapps.io'',
+        and ''RPubs'''
+      notes: Suggests
+      url: https://rstudio.github.io/rsconnect/
+      repository: https://CRAN.R-project.org/package=rsconnect
+      authors:
+      - family-names: Atkins
+        given-names: Aron
+        email: [email protected]
+      - family-names: Allen
+        given-names: Toph
+      - family-names: Wickham
+        given-names: Hadley
+      - family-names: McPherson
+        given-names: Jonathan
+      - family-names: Allaire
+        given-names: JJ
+      year: '2024'
     - type: software
       title: downlit
       abstract: 'downlit: Syntax Highlighting and Automatic Linking'
@@ -589,6 +629,19 @@ test <- cff_create("rmarkdown")
         email: [email protected]
       year: '2024'
       version: '>= 0.4.0'
+    - type: software
+      title: katex
+      abstract: 'katex: Rendering Math to HTML, ''MathML'', or R-Documentation Format'
+      notes: Suggests
+      url: https://docs.ropensci.org/katex/
+      repository: https://CRAN.R-project.org/package=katex
+      authors:
+      - family-names: Ooms
+        given-names: Jeroen
+        email: [email protected]
+        orcid: https://orcid.org/0000-0002-4035-0289
+      year: '2024'
+      version: '>= 1.4.0'
     - type: software
       title: sass
       abstract: 'sass: Syntactically Awesome Style Sheets (''Sass'')'
@@ -699,6 +752,18 @@ test <- cff_create("rmarkdown")
         given-names: Davis
         email: [email protected]
       year: '2024'
+    - type: software
+      title: cleanrmd
+      abstract: 'cleanrmd: Clean Class-Less ''R Markdown'' HTML Documents'
+      notes: Suggests
+      url: https://pkg.garrickadenbuie.com/cleanrmd/
+      repository: https://CRAN.R-project.org/package=cleanrmd
+      authors:
+      - family-names: Aden-Buie
+        given-names: Garrick
+        email: [email protected]
+        orcid: https://orcid.org/0000-0002-7111-0077
+      year: '2024'
     - type: software
       title: withr
       abstract: 'withr: Run Code ''With'' Temporarily Modified Global State'

codemeta.json

@@ -14,7 +14,7 @@
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.3.2 (2023-10-31)",
+  "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
   "provider": {
     "@id": "https://cran.r-project.org",
     "@type": "Organization",
@@ -200,7 +200,7 @@
   },
   "isPartOf": "https://ropensci.org",
   "keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "r", "r-package", "citation-file-format", "rstats", "ropensci", "cran"],
-  "fileSize": "929.883KB",
+  "fileSize": "947.576KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

man/roxygen/meta.R

@@ -3,7 +3,7 @@ list(
     core = "Other core functions of \\CRANpkg{cffr}:",
     reading = "Other functions for reading external files:",
     coercing = "Other functions for converting between \\strong{R} classes:",
-    write = "Other functions for creating external files:",
+    writing = "Other functions for creating external files:",
     bibtex = "Other functions for working with BibTeX format:",
     schemas = "Other CFF schemas:",
     git = "Other Git/GitHub helpers:",