provide_news_rd: Convert 'NEWS.md' to 'inst/NEWS.rd'

View source: R/news_rd.R

provide_news_rdR 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 fileinst/NEWS.rd to automatically be in sync with file./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.


packager documentation built on Aug. 16, 2023, 5:08 p.m.