getPackageNEWS: Retrieve and print package NEWS

Description Usage Arguments Value Author(s)

View source: R/getPackageNEWS.R

Description

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

Usage

1
2
3
4
5
6
getPackageNEWS(prevRepos="3.6",
	       currRepos="3.7",
	       repo=c("bioc", "data/experiment", "workflows"),
	       srcdir = NULL)
printNEWS(dbs, destfile, overwrite = FALSE, width = 68,
	  output=c("md", "text"), relativeLink=FALSE, ...)

Arguments

prevRepos

character(1) Bioconductor version from which NEWS starts.

currRepos

character(1) Bioconductor version for current packages.

repo

character(1) Which repository to get NEWS for. bioc is software packages, data/experiment is for data experiment packages and workflows for workflow packages

srcdir

Path to local checkout of package repositories, if NULL will try and use files on main builders

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.

relativeLink

Should links to packages be relative links on bioconductor.org website or include full url 'https//bioconductor.org'. default: FALSE is full url.

...

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 mtmorgan@fhcrc.org and Lori Shepherd


biocViews documentation built on Nov. 19, 2020, 2:01 a.m.