Re: [Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

2024-10-08 Thread John Clarke
Thanks again Dirk, So, I think my remaining issue is not to do with how we get the documents (roxygen2 or manually) but rather that there appears to be two (2) documents required by the R CMD check for the same class: *Rcpp_MyClass* and *MyClass*. and Rcpp_MyClass doesn't appear to be relevant to

Re: [Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

2024-10-04 Thread Dirk Eddelbuettel
On 4 October 2024 at 17:21, John Clarke wrote: | Indeed roxygen2 docs will help with a workaround, I think. I've temporarily | added a Rcpp_MyClass-class.RD based on promptClass("Rcpp_MyClass") and that | seems to satisfy the R CMD check. Nice, and I think that is about as it good as you will ge

Re: [Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

2024-10-04 Thread Dirk Eddelbuettel
John, As an aside, Rcpp has been spelled as 'Rcpp' (uppercase R, lowercase cpp, just as one often does for file extenions) for the roughly 20 years of its existence. Cheers, Dirk -- dirk.eddelbuettel.com | @eddelbuettel | e...@debian.org ___ Rcpp-de

Re: [Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

2024-10-04 Thread John Clarke
Thanks Dirk, Indeed roxygen2 docs will help with a workaround, I think. I've temporarily added a Rcpp_MyClass-class.RD based on promptClass("Rcpp_MyClass") and that seems to satisfy the R CMD check. However, I feel my confusion comes from the (I think) RCPP-generated *RCPP_MyClass* class. I don't

Re: [Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

2024-10-04 Thread Dirk Eddelbuettel
Hi John, That looks like a limitation in roxygen2 which appears to fully documented (as you desire) an S4 class. As you may know, you prod roxygen2 with 'NULL' blocks to add extra documentation -- that is likely what you need here. The roxygen2 docs will have more on this. Cheers, Dirk -- di