Type: Package
Title: Retrieve R Package News Files
Version: 0.0.2
Date: 2021-03-12
Description: Read R package news files, regardless of whether or not the package is installed.
License: MIT + file LICENSE
URL: https://github.com/owenjonesuob/pkgnews
BugReports: https://github.com/owenjonesuob/pkgnews/issues
Imports: utils
Suggests: commonmark, httr, xml2, covr, testthat
SystemRequirements: pandoc
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
NeedsCompilation: no
Packaged: 2021-03-12 16:57:01 UTC; ojones
Author: Owen Jones [aut, cre]
Maintainer: Owen Jones <owenjonesuob@gmail.com>
Repository: CRAN
Date/Publication: 2021-03-12 22:50:06 UTC

pkgnews: Retrieve R Package News Files

Description

Read R package news files, regardless of whether or not the package is installed.

Author(s)

Maintainer: Owen Jones owenjonesuob@gmail.com


Read package news

Description

Retrieve the NEWS file of a package as a character vector.

Usage

news(package, installed_only = FALSE, allow_changelog = TRUE, width = NULL)

Arguments

package

Character string giving the name of an R package.

installed_only

Only check installed packages.

allow_changelog

Whether to try and find a ChangeLog file if the NEWS can't be found.

width

An optional positive integer - see base::strwrap().

Value

A character vector containing the contents of the package's NEWS file (or possibly the ChangeLog file, if allow_changelog = TRUE). An error is thrown if no news could be found.

Examples

  ## Not run: news("pkgnews")