update_citation: Update the citation file for the dataset.

In washr: Publication Toolkit for Water, Sanitation and Hygiene (WASH) Data

Update the citation file for the dataset.

Description

Create a citation *.cff file for the dataset from a given DOI (Digital Object Identifier). When a DOI is supplied, it adds the DOI badge to the README RMarkdown file and re-builds the README.md and pkgdown website if they exist. Before a release exists, call it without arguments to generate the citation files without a DOI or badge.

Usage

update_citation(doi = NULL, build = TRUE)

Arguments

doi	DOI (Digital Object Identifier), e.g., 10.5281/zenodo.11185699.
build	Logical. Rebuild README.md and the pkgdown site after the citation files change? Defaults to TRUE. Set to FALSE to regenerate the citation files alone, e.g., in scripts and tests. Defaults to NULL for the pre-release call, in which case no DOI is recorded and no badge is added.

Value

NULL. A citation .cff file is written under the root directory.

See Also

Before: setup_website(). Run again with the DOI after the Zenodo release; update_metadata() then picks the DOI up.

Other metadata functions: update_description(), update_metadata()

Examples

## Not run: 
  update_citation(doi = "10.5281/zenodo.11185699")
  # Regenerate the citation files without rebuilding README.md and the site
  update_citation(build = FALSE)

## End(Not run)

washr documentation built on Sept. 2, 2026, 5:07 p.m.