From 54d4f08107059daf742a22d3d1cf9f0eb0c47c18 Mon Sep 17 00:00:00 2001 From: Diego H Date: Wed, 28 Aug 2024 16:33:28 +0200 Subject: [PATCH] Minimal doc updates --- CITATION.cff | 3 --- README.md | 8 +++----- codemeta.json | 4 ++-- data/cran_to_spdx.rda | Bin 944 -> 944 bytes inst/schemaorg.json | 2 +- man/cff_class.Rd | 4 ++-- vignettes/crosswalk.Rmd | 10 +++++----- 7 files changed, 13 insertions(+), 18 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index cebcddb..1c3dce9 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -143,9 +143,6 @@ references: email: jeroen@berkeley.edu orcid: https://orcid.org/0000-0002-4035-0289 year: '2024' - identifiers: - - type: url - value: https://arxiv.org/abs/1403.2805 doi: 10.32614/CRAN.package.jsonlite version: '>= 1.7.2' - type: software diff --git a/README.md b/README.md index a715455..03bcc30 100644 --- a/README.md +++ b/README.md @@ -73,8 +73,9 @@ file and the `CITATION` file (if present) of your package. Note that **cffr** works best if your package pass `R CMD check/devtools::check()`. -See [some projects already using -**cffr**](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code). +As per 2024-08-28 there are at least 288 repos on GitHub using **cffr**. +[Check them out +here](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code). ### Installation @@ -393,9 +394,6 @@ test <- cff_create("rmarkdown") email: jeroen@berkeley.edu orcid: https://orcid.org/0000-0002-4035-0289 year: '2024' - identifiers: - - type: url - value: https://arxiv.org/abs/1403.2805 doi: 10.32614/CRAN.package.jsonlite - type: software title: knitr diff --git a/codemeta.json b/codemeta.json index cab9f53..b5f4c69 100644 --- a/codemeta.json +++ b/codemeta.json @@ -14,7 +14,7 @@ "name": "R", "url": "https://r-project.org" }, - "runtimePlatform": "R version 4.4.1 (2024-06-14)", + "runtimePlatform": "R version 4.4.1 (2024-06-14 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": "1604.159KB", + "fileSize": "1624.479KB", "citation": [ { "@type": "ScholarlyArticle", diff --git a/data/cran_to_spdx.rda b/data/cran_to_spdx.rda index e145beba0eb15f190084fe055dd7ade1fff267d3..6d408fc153eef498e970646f1896d55f0612be1e 100644 GIT binary patch delta 19 XcmdnMzJZ-fzMF#q4A?euEn@}%C&vSo delta 19 XcmdnMzJZ-fzMF#q445}^En@}%C%6NW diff --git a/inst/schemaorg.json b/inst/schemaorg.json index 5165c2c..6c286ae 100644 --- a/inst/schemaorg.json +++ b/inst/schemaorg.json @@ -26,6 +26,6 @@ "name": "Comprehensive R Archive Network (CRAN)", "url": "https://cran.r-project.org" }, - "runtimePlatform": "R version 4.4.1 (2024-06-14)", + "runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)", "version": "1.1.1" } diff --git a/man/cff_class.Rd b/man/cff_class.Rd index 9ab1a06..f26167b 100644 --- a/man/cff_class.Rd +++ b/man/cff_class.Rd @@ -163,7 +163,7 @@ ref_list #> given-names: Charlie #> year: '2024' #> notes: R package version 2.3.10 -#> url: https://github.com/vubiostat/r-yaml/ +#> url: https://CRAN.R-project.org/package=yaml class(ref_list) #> [1] "cff_ref_lst" "cff" @@ -337,7 +337,7 @@ toBibtex(cit) #> author = \{Shawn P Garbett and Jeremy Stephens and Kirill Simonov and Yihui Xie and Zhuoer Dong and Hadley Wickham and Jeffrey Horner and \{reikoch\} and Will Beasley and Brendan O'Connor and Gregory R. Warnes and Michael Quinn and Zhian N. Kamvar and Charlie Gao\}, #> year = \{2024\}, #> note = \{R package version 2.3.10\}, -#> url = \{https://github.com/vubiostat/r-yaml/\}, +#> url = \{https://CRAN.R-project.org/package=yaml\}, #> \} # cff_pers, cff_pers_lst diff --git a/vignettes/crosswalk.Rmd b/vignettes/crosswalk.Rmd index 6cb0a9e..7c5b763 100644 --- a/vignettes/crosswalk.Rmd +++ b/vignettes/crosswalk.Rmd @@ -220,7 +220,7 @@ This key is extracted from the `DESCRIPTION` file following this logic: - If not present, from `"Date/Publication"`. This is present on packages built on **CRAN** and **Bioconductor**. or, - If not present, from `"Packaged"`, that is present on packages built by the - [r-universe](https://r-universe.dev/searchsearch/). + [r-universe](https://r-universe.dev/search).
@@ -512,10 +512,10 @@ citation("rmarkdown")[-1] This key is extracted from the `"Repository"` field of the `DESCRIPTION` file. Usually, this field is auto-populated when a package is hosted on a repo (like -**CRAN** or the [r-universe](https://r-universe.dev/search)). For packages without -this field on the `DESCRIPTION` (that is the typical case for an in-development -package), **cffr** would try to search the package on any of the default -repositories specified on `options("repos")`. +**CRAN** or the [r-universe](https://r-universe.dev/search)). For packages +without this field on the `DESCRIPTION` (that is the typical case for an +in-development package), **cffr** would try to search the package on any of the +default repositories specified on `options("repos")`. In the case of [Bioconductor](https://bioconductor.org/) packages, those are identified if a