update_citation: Create or update the citation files

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

Create or update the citation files

Description

The function extracts citation meta data from the project. Then it checks the required meta data. Upon success, it writes several files.

Usage

update_citation(x = ".", quiet = FALSE)

Arguments

x	Either a checklist object or a path to the source code. Defaults to ..
quiet	Whether to print check output during checking.

Details

• .zenodo.json contains the citation information in the format that Zenodo requires.

• CITATION.cff provides the citation information in the format that GitHub requires.

• inst/CITATION provides the citation information in the format that R packages require. It is only relevant for packages.

Value

An invisible checklist object.

Note

Source of the citation meta data:

• package: DESCRIPTION

• project: README.md

Should you want to add more information to the inst/CITATION file, add it to that file outside ⁠# begin checklist entry⁠ and ⁠# end checklist entry⁠.

See Also

Other both: add_badges(), check_filename(), check_lintr(), check_spelling(), custom_dictionary(), default_organisation(), print.checklist_spelling(), read_checklist(), read_organisation(), write_checklist(), write_citation_cff(), write_organisation(), write_zenodo_json()

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.