MassBank / RMassBank

Playground for experiments on the official http://bioconductor.org/packages/devel/bioc/html/RMassBank.html
Other
12 stars 15 forks source link

Updated documentation for various functions #302

Closed pstahlhofen closed 2 years ago

pstahlhofen commented 2 years ago

This is a version of fix-warnings which has the newest changes to dev (the JCAMP-parser) already integrated into it. You can either decide to merge this now (and to delete fix-warnings), or to continue using fix-warnings for further documentation and merge it later. In that case, you can remove this PR. Maay functions have been provided with documentation, for others existing documentation has been changed. In particular, the central RmbSpectrum2 class is now fully documented. A few changes to the code have also been made. See the diffs of 00101b799ea938c3f2089b21bb779b2314352d73 and a80a340fc1e35ac0a25431a0f3bdfb06202ec582 for details.

meowcat commented 2 years ago

I love all of this except for the pre-rendered RMarkdown files, do other packages do this?

meowcat commented 2 years ago

No html vignettes e.g. devtools https://github.com/r-lib/devtools/tree/main/inst processx https://github.com/r-lib/processx/tree/main/inst logger https://github.com/daroczig/logger/tree/master/inst

So I'm taking those out and merging the rest.

meowcat commented 2 years ago

Merged without the RMarkdown-render commit, bumped version, removed stray "michele" file