[Bioc-devel] Updating package NEWS files for Bioconductor 3.3 release announcement (and biocViews)
dtenenba at fredhutch.org
Tue Apr 26 20:04:38 CEST 2016
Package developers --
Each Bioconductor release is accompanied by release notes that mention
new packages and other significant project developments. For the
forthcoming release we will include release notes for
individual packages, so that users have an easy way to survey changes
in their favorite packages.
To have your package release notes made available in the Bioconductor
release notes, please arrange for your package to include a NEWS.Rd or
NEWS file that can be parsed by the utils::news function (please make sure
this function runs without error on your package, or your package NEWS will
not be included in the release announcement). We'll run
this command over all packages, using a 'query' argument that captures
all updates more recent than the start of the current release cycle.
For instance, Rsamtools in the devel branch is at version "1.23.9", so
we'll get news with
> utils::news(Version >= "1.23.0", "Rsamtools")
Note that both NEWS and NEWS.Rd files are NOT free-form text files, they each have
specific formats they must adhere to. See the Rsamtools NEWS file
(http://www.bioconductor.org/packages/devel/bioc/news/Rsamtools/NEWS) for an example
of the correct format for NEWS.
See ?news for more detail. We will collate these files no later than Friday,
April 29 at 5PM Seattle time.
Also, please make sure your biocViews are up-to-date/valid/relevant. This is important
because this is one of the main ways people will find your package. Refer to:
More information about the Bioc-devel