use_bioc_news_md: Create a biocthis-style NEWS.md file

In lcolladotor/biocthis: Automate package and project setup for Bioconductor packages

Create a biocthis-style NEWS.md file

Description

This function is very similar to usethis::use_news_md() except that it uses a template from biocthis.

Usage

use_bioc_news_md(open = rlang::is_interactive())

Arguments

open	Open the newly created file for editing? Happens in RStudio, if applicable, or via utils::file.edit() otherwise. This argument has the same behavior as the open argument used in usethis functions.

Details

Unlike the original function, use_bioc_news_md() does not make git commits. So you won't lose work you didn't save when using this function.

Value

This function adds and/or replaces the NEWS.md file in your R package.

Examples

## Not run: 
## Run this function in your package
use_bioc_news_md()

## End(Not run)

## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg()

## Create a template NEWS.md file that is Bioconductor-friendly
biocthis::use_bioc_news_md()

lcolladotor/biocthis documentation built on May 5, 2024, 6:15 a.m.