From 6d8ece239d483ead78e1df54e896ef6718ab0cc3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 17:58:18 +0000 Subject: [PATCH] Update docs with pkgdev --- CITATION.cff | 3 +++ README.md | 25 ++++++++++++++++++++----- codemeta.json | 6 +++--- data/cran_to_spdx.rda | Bin 916 -> 916 bytes inst/schemaorg.json | 2 +- man/cff-class.Rd | 11 +++++------ man/chunks/cffclass.Rmd | 9 ++++----- 7 files changed, 36 insertions(+), 20 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index ae2c7213..59675863 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -138,6 +138,9 @@ 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 version: '>= 1.7.2' - type: software title: jsonvalidate diff --git a/README.md b/README.md index 11d7750f..b20d2624 100644 --- a/README.md +++ b/README.md @@ -385,6 +385,9 @@ 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 - type: software title: knitr abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' @@ -750,6 +753,18 @@ test <- cff_create("rmarkdown") given-names: Davis email: davis@posit.co 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: garrick@adenbuie.com + orcid: https://orcid.org/0000-0002-7111-0077 + year: '2024' - type: software title: withr abstract: 'withr: Run Code ''With'' Temporarily Modified Global State' @@ -888,9 +903,9 @@ for more info.
-Boettiger, Carl, and Maëlle Salmon. 2021a. -*codemeta: A Smaller -codemetar Package*. +Boettiger, Carl, and Maëlle Salmon. 2021a. *codemeta: A Smaller codemetar Package*. .
@@ -911,8 +926,8 @@ Among Citation Formats*.
-Dietrich, Jan Philipp, and Waldir Leoncio. 2022. -*citation: Software Citation Tools*. +Dietrich, Jan Philipp, and Waldir Leoncio. 2022. *citation: Software Citation Tools*.
diff --git a/codemeta.json b/codemeta.json index e3f6821c..6db1f419 100644 --- a/codemeta.json +++ b/codemeta.json @@ -14,7 +14,7 @@ "name": "R", "url": "https://r-project.org" }, - "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)", + "runtimePlatform": "R version 4.3.2 (2023-10-31)", "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": "1048.177KB", + "fileSize": "1030.282KB", "citation": [ { "@type": "ScholarlyArticle", @@ -286,7 +286,7 @@ "sameAs": "https://doi.org/10.5281/zenodo.5171937" } ], - "releaseNotes": "https://github.com/ropensci/cffr/blob/main/NEWS.md", + "releaseNotes": "https://github.com/ropensci/cffr/blob/master/NEWS.md", "readme": "https://github.com/ropensci/cffr/blob/main/README.md", "contIntegration": ["https://github.com/ropensci/cffr/actions/workflows/check-full.yaml", "https://app.codecov.io/gh/ropensci/cffr", "https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml"], "developmentStatus": ["https://www.repostatus.org/#active", "https://lifecycle.r-lib.org/articles/stages.html#experimental"], diff --git a/data/cran_to_spdx.rda b/data/cran_to_spdx.rda index 0bd1435cae708e762b962cb7a97ec9ae0c12fef9..54267cd1b0840c06bdfc1e554391353a60cd0a13 100644 GIT binary patch delta 19 XcmbQjK82l2zMF#q445}^buj|~Baj0= delta 19 XcmbQjK82l2zMF#q4A?eubuj|~BcB67 diff --git a/inst/schemaorg.json b/inst/schemaorg.json index dec7a9c6..8056af78 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.3.2 (2023-10-31 ucrt)", + "runtimePlatform": "R version 4.3.2 (2023-10-31)", "version": "0.5.0.9000" } diff --git a/man/cff-class.Rd b/man/cff-class.Rd index 8f856d3e..b6205b88 100644 --- a/man/cff-class.Rd +++ b/man/cff-class.Rd @@ -136,11 +136,10 @@ c(minimal_cff, new_keys) Special case for those CFF keys that are person-like. -\if{html}{\out{
}}\preformatted{ - path <- system.file("examples/CITATION_complete.cff", package = "cffr") - the_cff <- cff_read(path) +\if{html}{\out{
}}\preformatted{path <- system.file("examples/CITATION_complete.cff", package = "cffr") +the_cff <- cff_read(path) - the_cff$authors +the_cff$authors #> - family-names: Real Person #> given-names: One Truly #> name-particle: van der @@ -171,8 +170,8 @@ Special case for those CFF keys that are person-like. #> date-start: '2017-01-01' #> date-end: '2017-01-31' #> location: The team garage - - as.person(the_cff$authors) + +as.person(the_cff$authors) #> [1] "One Truly van der Real Person IV (Citey, Excellent University, Niceplace, Arcadia, 22 Acacia Avenue, Citationburgh, Renfrewshire, C13 7X7, GB, , +44(0)141-323 4567, +44(0)141-323 45678, https://www.entity-project-team.io)" #> [2] "Entity Project Team Conference entity (Entity Project Team Conference entity, 22 Acacia Avenue, Citationburgh, Renfrewshire, C13 7X7, GB, , +44(0)141-323 4567, +44(0)141-323 45678, https://www.entity-project-team.io, 2017-01-01, 2017-01-31, The team garage)" }\if{html}{\out{
}} diff --git a/man/chunks/cffclass.Rmd b/man/chunks/cffclass.Rmd index c2ca6834..cd673784 100644 --- a/man/chunks/cffclass.Rmd +++ b/man/chunks/cffclass.Rmd @@ -72,11 +72,10 @@ c(minimal_cff, new_keys) Special case for those CFF keys that are person-like. ```{r} +path <- system.file("examples/CITATION_complete.cff", package = "cffr") +the_cff <- cff_read(path) - path <- system.file("examples/CITATION_complete.cff", package = "cffr") - the_cff <- cff_read(path) +the_cff$authors - the_cff$authors - - as.person(the_cff$authors) +as.person(the_cff$authors) ```