Style Guide
StyleGuide.RmdExpected Documentation
- every function/data object should have the appropriate Doxygen comments. (see here for more details on documenting functions and data)
- Functions must include the following tags
-
@paramto describe every function argument (if any) -
@returnto describe the object returned by the function (if any)
-
- add a vignette or article to document or demonstrate package capabilities when approporiate
Coding Style
- follows the R package format and style guidelines
- R CMD checks should pass CRAN checks
- follows the R style guide
Unit Testing
- add R package unit tests!