A report's CITATION.cff is the one record its citations come from. Its title and
authors are written by hand; this function rewrites only what a build changes, so it
can run at the end of every build:
Usage
xct_cff_refresh(
path = "CITATION.cff",
report_url,
repo_url,
desc = "DESCRIPTION",
today = Sys.Date()
)Arguments
- path
character Path to the
CITATION.cffto refresh. It must exist and carry apreferred-citationblock.- report_url
character The URL the report is served at.
- repo_url
character The URL of the report's source repository.
- desc
character Path to the
DESCRIPTIONthat holdsVersionand, optionally,Config/DOI.- today
Date The date to stamp. Defaults to
Sys.Date().
Details
date-released, anddate-publishedandyearinpreferred-citation: the build date, because the version on the web is the one being dated;version, at both levels:VersioninDESCRIPTION, so a citation names the version it was made from as well as the date;urlandrepository-code, at both levels;doi, at both levels:Config/DOIinDESCRIPTION, when the repository is archived (a Zenodo concept DOI, for example).
The refreshed record must pass cffr::cff_validate() before it replaces path;
otherwise nothing is written.
See also
Other cff:
xct_bib_from_cff()
Examples
d <- tempfile("report_")
dir.create(d)
writeLines(c("Package: report", "Version: 0.2.0"), file.path(d, "DESCRIPTION"))
writeLines(c(
"cff-version: 1.2.0",
"message: If you use this report, please cite it as below.",
"title: A report",
"authors:",
"- family-names: Irvine",
" given-names: Allan",
"type: software",
"preferred-citation:",
" type: report",
" title: A report",
" authors:",
" - family-names: Irvine",
" given-names: Allan",
" institution:",
" name: New Graph Environment Ltd.",
" year: 2024"
), file.path(d, "CITATION.cff"))
xct_cff_refresh(
path = file.path(d, "CITATION.cff"),
report_url = "https://www.example.com/a_report/",
repo_url = "https://github.com/example/a_report",
desc = file.path(d, "DESCRIPTION"),
today = as.Date("2026-10-31")
)
#> /tmp/RtmpQQ7JcT/report_18cf28c8d653/CITATION.cff refreshed: version 0.2.0 dated 2026-10-31 (no DOI)
cat(readLines(file.path(d, "CITATION.cff")), sep = "\n")
#> cff-version: 1.2.0
#> message: If you use this report, please cite it as below.
#> title: A report
#> authors:
#> - family-names: Irvine
#> given-names: Allan
#> type: software
#> preferred-citation:
#> type: report
#> title: A report
#> authors:
#> - family-names: Irvine
#> given-names: Allan
#> institution:
#> name: New Graph Environment Ltd.
#> year: 2026
#> date-published: '2026-10-31'
#> url: https://www.example.com/a_report/
#> repository-code: https://github.com/example/a_report
#> version: 0.2.0
#> date-released: '2026-10-31'
#> url: https://www.example.com/a_report/
#> repository-code: https://github.com/example/a_report
#> version: 0.2.0