provide_news_rd {packager}R Documentation

Convert ‘NEWS.md’ to ‘inst/NEWS.rd

Description

The file ‘inst/NEWS.rd’ will get listed in the package's help index. Christian Vonderach uses the index thus wants ‘inst/NEWS.rd’ to automatically be in sync with ‘./NEWS.md’.

Usage

provide_news_rd(path = ".", force = is_force(), verbose = TRUE)

Arguments

path

Path to the package directory (see devtools::as.package).

force

Overwrite an existing file?

verbose

Be verbose?

Value

TRUE on success, FALSE otherwise.


[Package packager version 1.15.3 Index]