getPackageNEWS: Retrieve and print package NEWS

Description Usage Arguments Value Author(s)

View source: R/getPackageNEWS.R

Description

These functions visit two repository PACKAGE files, identifying packages that are present in the ‘current’ repository and have NEWS since the base version of the same package in the ‘previous’ repository. All NEWS is reported for packages only in the current repository.

Usage

1
2
3
4
5
getPackageNEWS(prevRepos="https://bioconductor.org/packages/release/bioc", 
               currRepos="https://bioconductor.org/packages/devel/bioc", 
               srcDir)
printNEWS(dbs, destfile, overwrite = FALSE, width = 68,
          output=c("md", "text"), ...)

Arguments

prevRepos

character(1) repository from which NEWS starts.

currRepos

character(1) repository of current packages.

srcDir

character(1) directory containing the source all current pacakges

dbs

A list of news_db elements, as returned by getPackageNEWS.

destfile

character(1) file path to the location where NEWS will be printed.

overwrite

logical(1) indicating whether destfile can be over-written, if it exists.

width

numeric(1) number of characters news items are to be wrapped to, excluding indent.

output

character(1) output to text or markdown format.

...

additional arguments, unused.

Value

A list of news_db files, as returned by utils::news, for each package for which relevant NEWS is available.

Author(s)

Martin Morgan [email protected]


Bioconductor-mirror/biocViews documentation built on June 1, 2017, 5:19 a.m.