update_description: Update the DESCRIPTION file to conform with openwashdata...

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

Update the DESCRIPTION file to conform with openwashdata standards

Description

This function updates the DESCRIPTION file of an R package to comply with openwashdata standards. It ensures that fields such as License, Language, Date, URL, and others are correctly specified.

Usage

update_description(
  file = ".",
  github_user = "https://github.com/openwashdata/"
)

Arguments

file	Character. The file path to the DESCRIPTION file of the R package. Defaults to the current working directory.
github_user	Character. The URL path to the GitHub user or organization that hosts the current package. Defaults to "https://github.com/openwashdata".

Value

NULL. Update fields directly in DESCRIPTION file.

Examples

## Not run: 
 # Update DESCRIPTION file in the current package
update_description()

 # Update DESCRIPTION file in a specific package
update_description(file = "path/to/your/package/DESCRIPTION")

 # Update DESCRIPTION file with a specific GitHub user
update_description(github_user = "https://github.com/yourusername")

## End(Not run)

washr documentation built on April 4, 2025, 1:10 a.m.