From 2c531d4baadc59d19794cfc094d3fb7cfe01b677 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 8 Jul 2024 21:24:45 +0000
Subject: [PATCH] Update docs with pkgdev
---
CITATION.cff | 2 ++
DESCRIPTION | 2 +-
README.md | 7 +++++--
codemeta.json | 2 +-
man/as_cff_person.Rd | 2 --
man/cff_class.Rd | 42 +++++++-----------------------------------
6 files changed, 16 insertions(+), 41 deletions(-)
diff --git a/CITATION.cff b/CITATION.cff
index fb76f56..aec480c 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -199,6 +199,8 @@ references:
given-names: Michael
- family-names: Kamvar
given-names: Zhian N.
+ - family-names: Gao
+ given-names: Charlie
year: '2024'
doi: 10.32614/CRAN.package.yaml
version: '>= 2.2.1'
diff --git a/DESCRIPTION b/DESCRIPTION
index ea77888..106c5bb 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -39,7 +39,7 @@ Config/testthat/parallel: true
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
X-schema.org-isPartOf: https://ropensci.org
X-schema.org-keywords: attribution, citation, credit, citation-files, cff,
metadata
diff --git a/README.md b/README.md
index 2c14133..6051a59 100644
--- a/README.md
+++ b/README.md
@@ -72,8 +72,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-07-08 there are at least 322 repos on GitHub using **cffr**.
+[Check them out
+here](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code).
### Installation
@@ -504,6 +505,8 @@ test <- cff_create("rmarkdown")
given-names: Michael
- family-names: Kamvar
given-names: Zhian N.
+ - family-names: Gao
+ given-names: Charlie
year: '2024'
doi: 10.32614/CRAN.package.yaml
version: '>= 2.1.19'
diff --git a/codemeta.json b/codemeta.json
index dbf453a..4633679 100644
--- a/codemeta.json
+++ b/codemeta.json
@@ -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": "1606.098KB",
+ "fileSize": "1604.946KB",
"citation": [
{
"@type": "ScholarlyArticle",
diff --git a/man/as_cff_person.Rd b/man/as_cff_person.Rd
index d85b53e..01b3653 100644
--- a/man/as_cff_person.Rd
+++ b/man/as_cff_person.Rd
@@ -73,9 +73,7 @@ entity <- "Elephant and Castle"
as_cff_person(entity)
- name: Elephant
- name: Castle
-}\if{html}{\out{}}
-\if{html}{\out{}}\preformatted{
# Do
entity_protect <- "\{Elephant and Castle\}"
as_cff_person(entity_protect)
diff --git a/man/cff_class.Rd b/man/cff_class.Rd
index 14b4f30..af0a4c1 100644
--- a/man/cff_class.Rd
+++ b/man/cff_class.Rd
@@ -49,9 +49,7 @@ a_cff_object <- as_cff(a_named_list)
class(a_cff_object)
#> [1] "cff"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
a_cff_object
#> first: I
#> second: am
@@ -59,9 +57,7 @@ a_cff_object
#> fourth: list
#> fifth: with
#> sixth: names
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
is.list(a_cff_object)
#> [1] TRUE
}\if{html}{\out{
}}
@@ -105,28 +101,20 @@ two_persons
#> orcid: https://orcid.org/0000-0000-0000-0000
#> - name: An entity
#> email: fake@gmail.com
-}\if{html}{\out{}}
-\if{html}{\out{}}\preformatted{
class(two_persons)
#> [1] "cff_pers_lst" "cff"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
# Single element
two_persons[[1]]
#> family-names: person
#> given-names: A
#> orcid: https://orcid.org/0000-0000-0000-0000
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
class(two_persons[[1]])
#> [1] "cff_pers" "cff"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
# Array of references
cit <- c(citation(), citation("yaml"))
@@ -171,17 +159,15 @@ ref_list
#> given-names: Michael
#> - family-names: Kamvar
#> given-names: Zhian N.
-#> year: '2023'
-#> notes: R package version 2.3.8
+#> - family-names: Gao
+#> given-names: Charlie
+#> year: '2024'
+#> notes: R package version 2.3.9
#> url: https://github.com/vubiostat/r-yaml/
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
class(ref_list)
#> [1] "cff_ref_lst" "cff"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
# Single element
ref_list[[1]]
@@ -194,9 +180,7 @@ ref_list[[1]]
#> address: Vienna, Austria
#> year: '2024'
#> url: https://www.R-project.org/
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
class(ref_list[[1]])
#> [1] "cff_ref" "cff"
}\if{html}{\out{
}}
@@ -210,9 +194,7 @@ Creating a \code{cff} object does not ensure its validity according to the \href
\if{html}{\out{}}\preformatted{class(a_cff_object)
#> [1] "cff"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
cff_validate(a_cff_object)
#> == Validating cff ==============================================================
#> x Oops! This has the following errors:
@@ -244,9 +226,7 @@ cff_valid
#> cff-version: 1.2.0
#> message: Hi there
#> title: My title
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
cff_validate(cff_valid)
#> == Validating cff ==============================================================
#> v Congratulations! This is valid
@@ -268,16 +248,12 @@ minimal_cff
#> authors:
#> - family-names: Doe
#> given-names: John
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
as_df <- as.data.frame(minimal_cff)
class(as_df)
#> [1] "data.frame"
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
t(as_df)
#> [,1]
#> cff_version "1.2.0"
@@ -344,9 +320,7 @@ toBibtex(minimal_cff)
#> title = \{My Research Software\},
#> author = \{John Doe\},
#> \}
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
# cff_ref, cff_ref_lst
toBibtex(cit)
#> @Manual\{,
@@ -360,14 +334,12 @@ toBibtex(cit)
#>
#> @Manual\{,
#> title = \{yaml: Methods to Convert R Data to YAML and Back\},
-#> 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\},
-#> year = \{2023\},
-#> note = \{R package version 2.3.8\},
+#> 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.9\},
#> url = \{https://github.com/vubiostat/r-yaml/\},
#> \}
-}\if{html}{\out{
}}
-\if{html}{\out{}}\preformatted{
# cff_pers, cff_pers_lst
toBibtex(two_persons)
#> [1] "person, A and \{An entity\}"