clean_description_file: Make a Default DESCRIPTION File Pass 'R CMD check'

View source: R/utils.R

clean_description_fileR Documentation

Make a Default DESCRIPTION File Pass R CMD check

Description

utils::package.skeleton leaves us with a DESCRIPTION that throws a warning in R CMD check. Fix that.

Usage

clean_description_file(path)

Arguments

path

Path to the DESCRIPTION file or the directory containing it.

Value

Invisibly NULL.

Examples

if (! exists("dummy")) assign("dummy", "dumb")
utils::package.skeleton(path = tempdir())
old <- readLines(file.path(tempdir(), "anRpackage", "DESCRIPTION"))
document:::clean_description_file(path = file.path(tempdir(), "anRpackage",
                                        "DESCRIPTION"))
new <- readLines(file.path(tempdir(), "anRpackage", "DESCRIPTION"))
setdiff(new, old)

document documentation built on Aug. 19, 2022, 5:23 p.m.