Best development and documenting practices for R6-class packages

Hi,

I am working on a new package which essentially provides a new R6 class with associated methods (and that is pretty much it). At the moment, the package contains a single .R file where the class is defined and a single .Rd file where the class is documented.

While the class now offers a limited number of methods, I anticipate the addition of many more methods in the future. Therefore, I am questioning my choice of a single R file and single Rd file...

I was wondering if the community could provide insights on the best development and documenting practices for packages based upon R6 classes.

Thanks in advance

2 Likes

The latest roxygen2 release has some special R6 support: https://roxygen2.r-lib.org/articles/rd.html#r6

3 Likes