This function is very similar to usethis::use_news_md() except that it
uses a template from biocthis.
use_bioc_news_md(open = rlang::is_interactive())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.
This function adds and/or replaces the NEWS.md file in your
R package.
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.
if (FALSE) {
## Run this function in your package
use_bioc_news_md()
}
## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg()
#> ✔ Setting active project to '/tmp/RtmpTHfQjN/biocthisexample'
#> Package: biocthisexample
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#> * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID)
#> Description: What the package does (one paragraph).
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to
#> pick a license
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.2.3
#> ✔ Setting active project to '/tmp/RtmpTHfQjN/biocthisexample'
## Create a template NEWS.md file that is Bioconductor-friendly
biocthis::use_bioc_news_md()
#> ✔ Writing 'NEWS.md'