collect: Compile NEWS files from several packages

In waldronlab/newsfeed: Compilies NEWS files from different packages

Compile NEWS files from several packages

Description

This package will take the first chunk of a NEWS file and return it as a character vector. Users should call this function within a folder *above* all of the packages in the 'packages' argument. This will ensure that the proper NEWS path is obtained.

Usage

collect(
  packages,
  vpattern = "Changes in version",
  render = TRUE,
  rawHTML = FALSE
)

Arguments

packages	character() A vector of packages with NEWS files
vpattern	character(1) The 'grep' input for searching the versioning line in the NEWS files. This usually starts with 'Changes in version' but may differ.
render	logical(1) Whether to produce an HTML document for viewing (default: TRUE)
rawHTML	logical(1) Whether to return the raw HTML text when 'render = TRUE' (default: FALSE)

Details

The NEWS file location can be in one of four locations relative to the package directory:

• "NEWS.md"

• "NEWS"

• "inst/NEWS"

• "inst/NEWS.md"

• "inst/NEWS.Rd"

Obtained from Bioconductor NEWS guidelines: https://www.bioconductor.org/developers/package-guidelines/#news

Examples

collect("newsfeed")
## Not run: 
    pkgs <- c(
        "MultiAssayExperiment", "curatedTCGAData", "TCGAutils",
        "cBioPortalData", "SingleCellMultiModal", "RTCGAToolbox",
        "RaggedExperiment", "terraTCGAdata", "BiocBaseUtils", "TENxIO",
        "BiocHubsShiny"
    )
    stopifnot(all(dir.exists(pkgs)))
    collect(pkgs)

## End(Not run)

waldronlab/newsfeed documentation built on July 30, 2023, 1:22 a.m.