Should I document R6 methods with `@examples` for CRAN submission?

Package development
1

I'll be submitting a package to CRAN soon. The package is built around two R6 classes.
I've been through the R packages book, that says all exported functions should have @examples and @returns. I find the way R6 classes handle method examples a bit awkward and would prefer users to rely on the examples in the vignettes instead.

Does anyone know if the "all exported functions should have @examples" thing also applies to R6 methods?

2

No, it applies to the whole class. You don't need to provide an example for each method.

3

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.