Roxygen2 documentation

[evanbiederstedt]

Hi @manzt

This is my normal spiel below:

It would be nice to get this on CRAN when the code is ready. The big impediment to this is always the roxygen2 documentation.

--- if a function is not exported, please use the tag #' @keywords internal. It's useful to know which functions are exported and which are not
--- if a function is exported, please document all fields. Please use the format #' @parameterName type Explanation here (default=xxx). It's very useful to know the data type in the rxoygen2 comments.
--- it will be useful for CRAN reviews if all exported functions have examples, but....that doesn't always happen. But let's try our best.

With this, the other steps will be much easier, and we can quickly get this on CRAN.

Once you're ready to publish the package, let me know. I'll help clean things up.

See related discussions e.g. here: kharchenkolab/numbat#1

Thanks, Evan

[manzt]

Super useful. Thank you!! I'll ping you when I've cleaned things up.