search

waldronlab / bugsigdbr

R-side access to published microbial signatures from BugSigDB
https://bioconductor.org/packages/bugsigdbr
GNU General Public License v3.0
4 stars 2 forks source link

Informative news for 1.0.0 #21

Closed lwaldron closed 2 years ago

lwaldron commented 2 years ago

Let's use this format for NEWS.md for compatibility with Marcel's packages, will make consistent updates/announcements much easier.

lwaldron commented 2 years ago

Just FYI @jwokaty and @lgeistlinger I set a NEWS.md Markdown style here that it would be nice to stick with for consistency with @LiNk-NY's style.

LiNk-NY commented 2 years ago

Perhaps use an x.y.z (e.g., 3.14.0) version format but otherwise, it looks good to me! FWIW, you can check the formatting with:

tools:::.build_news_db("bugsigdbr")
#>                         Changes in version 3.14                         
#> 
#> New features
#> 
#>   - importBugSigDB: Obtain published microbial signatures from
#>     bugsigdb.org
#>   - getSignatures: Obtain microbe signatures from BugSigDB
#>   - restrictTaxLevel: Restrict microbe signatures to specific taxonomic
#>     levels
#>   - extractTaxLevel: Extract specific taxonomic levels from a microbe
#>     signature
#>   - writeGMT: Write microbe signatures to file in GMT format
#>   - browseSignature: Displaying BugSigDB signatures pages in a web
#>     browser
#>   - browseTaxon: Displaying BugSigDB taxon pages in a web browser
#> 
#> Bug fixes and minor improvements
#> 
#> No news yet here.

Created on 2021-10-28 by the reprex package (v2.0.1)

I wouldn't add empty sections but that may be a matter of personal preference.