Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.32 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.32 KB
Raw

pkgnews: Retrieve R Package News Files

CRAN status R build status Codecov test coverage

Read R package news files, regardless of whether or not the package is currently installed, into your R session as a character vector.

Installation

You can install the released version from CRAN using:

install.packages("pkgnews")

Alternatively, you can install the latest version from GitHub using:

remotes::install_github("owenjonesuob/pkgnews")

Usage

The package only contains one exported function, news(), which can be used to retrieve the news for a specified package:

library(pkgnews)
news("pkgnews")

Note that the package doesn't need to be installed - though an internet connection must be available if that's the case.

news() checks for an installed copy of the package, followed by valid locations for the NEWS (or ChangeLog, if allow_changelog = TRUE) file on CRAN and Bioconductor.