<div dir="ltr"><div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><pre style="color:rgb(0,0,0)">Hello all,</pre><pre style="color:rgb(0,0,0)">I'm encountering a similar problem to the one resolved (in 2017) at the bottom of this e-mail. I'm getting the same error from rcmdcheck(). However, my RCPP_MODULE class is in C++ (not R) and the '@alias' solution that Dirk proposed doesn't appear to work in my case.</pre><pre style="color:rgb(0,0,0)">In ./src/wrapper.cpp, I do something like:</pre><pre style="color:rgb(0,0,0)"><div style="color:rgb(204,204,204);background-color:rgb(31,31,31);font-family:Menlo,Monaco,"Courier New",monospace;font-size:12px;line-height:18px"><div><span style="color:rgb(156,220,254)">RCPP_MODULE</span>(MyModule) {</div><div>   <span style="color:rgb(197,134,192)">using</span> <span style="color:rgb(86,156,214)">namespace</span> <span style="color:rgb(78,201,176)">Rcpp</span>;</div><div><span style="color:rgb(106,153,85)">//' </span>MyCPPClass<span style="color:rgb(106,153,85)"> Class</span></div><div><span style="color:rgb(106,153,85)">//' @name </span>MyCPPClass</div><div><span style="color:rgb(106,153,85)">//' @title Test title </span>MyCPPClass</div><div><span style="color:rgb(106,153,85)">//' @export</span></div><div><span style="color:rgb(106,153,85)">//' @description Type the name of the class to see its methods</span></div><div><span style="color:rgb(106,153,85)">//' @field new Constructor</span></div><div><span style="color:rgb(106,153,85)">//' @field mult Multiply by another Double object \itemize{</span></div><div><span style="color:rgb(106,153,85)">//' \item Parameter: other - The other Double object</span></div><div><span style="color:rgb(106,153,85)">//' \item Returns: product of the values</span></div><div><span style="color:rgb(106,153,85)">//' }</span></div><div>   <span style="color:rgb(220,220,170)">class_</span><MyCPPClass>(<span style="color:rgb(206,145,120)">"</span>MyCPPClass<span style="color:rgb(206,145,120)">"</span>)</div></div></pre><pre style="color:rgb(0,0,0)"><pre style="text-wrap: wrap;">And roxygen2 generates MyCPPClass.Rd but not Rcpp_MyCPPClass.Rd (which makes sense to me because I understand it to essentially be an alias to MyCPPClass). However, when I run rcmdcheck() I get the following error pertaining to Rcpp_MyCPPClass. Adding @alias or @aliases doesn't seem to work either. rcmdcheck() appears to be looking for Rcpp_MyCPPClass.Rd</pre></pre><pre style="color:rgb(0,0,0)">❯ checking for missing documentation entries ... WARNING<br>  Undocumented S4 classes:<br>    ‘Rcpp_MyCPPClass’<br>  All user-level objects in a package (including S4 classes and methods)<br>  should have documentation entries.<br>  See chapter ‘Writing R documentation files’ in the ‘Writing R<br>  Extensions’ manual.<br></pre><pre style="color:rgb(0,0,0)"><font face="Arial, Helvetica, sans-serif">Is there a way to satisfy the documentation requirements for these kinds of "Rcpp_" S4 classes that are (I guess) generated by RCPP?</font></pre><pre style="color:rgb(0,0,0)"><span style="font-family:Arial,Helvetica,sans-serif">RELATED problem and solution for reference:</span></pre><pre style="color:rgb(0,0,0)"><span style="font-family:Arial,Helvetica,sans-serif">On 15 August 2017 at 16:12, Luis Avila wrote:</span><br></pre><pre style="color:rgb(0,0,0)">|<i> I've used Roxygen to document my R classes

| but having problems now documenting Rcpp exposed classes from my C++ code.

</i>|<i> 

</i>|<i> I am creating .Rd files manually and that partially solves the problem but

| looking for a better way.

</i>|<i> 

| I have a module expossing c++ classes Model and NormalModel.

</i>|<i> Running R CMD check --as-cran I get:

</i>|<i> 

</i>|<i> Undocumented code objects:

</i>|<i> 'Model'

</i>|<i> 

</i>|<i> Undocumented S4 classes

</i>|<i> 'Rcpp_Model' 'Rcpp_NormalModel'

</i>|<i> 

</i>|<i> I managed to get the "undocumented code object" message to stop reporting

</i>|<i> "NormalModel" as undocumented by manually setting up a NormalModel-class.Rd

| file in man but can't get rid of Rcpp_NormalModel.

</i>

One \alias{} entry in the Rd should do. See eg the (still rather basic /

stub) page I put in for RcppAnnoy (which is just Rcpp Modules):

<a href="https://github.com/eddelbuettel/rcppannoy/blob/master/man/RcppAnnoy-package.Rd">https://github.com/eddelbuettel/rcppannoy/blob/master/man/RcppAnnoy-package.Rd</a>

You can write it as Rd, or you can write it in an (empty) R file to be used

by roxygen2 (though I still never let roxygen touch my NAMESPACE, DESCRIPTION

or other files -- but Rd creation I trust).

Dirk

</pre><br class="gmail-Apple-interchange-newline"></div><div dir="ltr"><br></div><div dir="ltr"><br></div></div></div>