search

MG-RAST / matR

Metagenomics Analysis Tools
https://mg-rast.github.io/matR
Other
25 stars 10 forks source link

Documentation needed. Maybe use Roxygen2 #3

Closed joey711 closed 7 years ago

joey711 commented 12 years ago

Since most of the documentation is currently empty, consisting of the automatically-generated skeleton .Rd files, my recommendation would be to use roxygen, since this is becoming very popular and automatically performs other checks and generates a NAMESPACE file.

The github devel page includes documentation and discussion.

https://github.com/klutometis/roxygen

I'm also happy to help out with this.

joey711 commented 12 years ago

I think examples for the kbGet function and/or the demo code would be extremely useful. Not just for using what is already included in the package, but also for me to develop wrappers in my own package and/or contributing functionality to this package.

DrOppenheimer commented 12 years ago

We'll also place this on the agenda for early next week.