alter_description_file: Alter Contents of a DESCRIPTION File

In document: Run 'roxygen2' on (Chunks of) Single Code Files

Alter Contents of a DESCRIPTION File

Description

Substitutes and/or adds fields in a DESCRIPTION file.

Usage

alter_description_file(path, substitution = NULL, addition = NULL)

Arguments

path	Path to the DESCRIPTION file or the directory containing it.
substitution	A list of named character vector giving the pairs for substitution.
addition	A list of named character vector giving the pairs for addition.

Value

value of write.dcf.

Note

Adding NULL elements (Title = NULL, for example) to substitution does not delete or overwrite the entry in the DESCRIPTION file.
alter_description_file() is deprecated, please use CRAN package desc.

document documentation built on July 9, 2023, 5:22 p.m.