Skip to content

[Rcpp-devel] best way of documenting Rcpp Modules

2 messages · Luis Avila, Dirk Eddelbuettel

Luis Avila
# 
I've used Roxygen to document my R classes
but having problems now documenting Rcpp exposed classes from my C++ code.

I am creating .Rd files manually and that partially solves the problem but
looking for a better way.

I have a module expossing c++ classes Model and NormalModel.
Running R CMD check --as-cran I get:

Undocumented code objects:
'Model'

Undocumented S4 classes
'Rcpp_Model' 'Rcpp_NormalModel'

I managed to get the "undocumented code object" message to stop reporting
"NormalModel" as undocumented by manually setting up a NormalModel-class.Rd
file in man but can't get rid of Rcpp_NormalModel.

Is there a way to hide the classes with the Rcpp suffix, or what is the
recommended way to fix this problem?

Thank you.

Luis
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/rcpp-devel/attachments/20170815/ef20b20c/attachment.html>
Dirk Eddelbuettel
#
On 15 August 2017 at 16:12, Luis Avila wrote:
| I've used Roxygen to document my R classes
| but having problems now documenting Rcpp exposed classes from my C++ code.
| 
| I am creating .Rd files manually and that partially solves the problem but
| looking for a better way.
| 
| I have a module expossing c++ classes Model and NormalModel.
| Running R CMD check --as-cran I get:
| 
| Undocumented code objects:
| 'Model'
| 
| Undocumented S4 classes
| 'Rcpp_Model' 'Rcpp_NormalModel'
| 
| I managed to get the "undocumented code object" message to stop reporting
| "NormalModel" as undocumented by manually setting up a NormalModel-class.Rd
| file in man but can't get rid of Rcpp_NormalModel.

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):

https://github.com/eddelbuettel/rcppannoy/blob/master/man/RcppAnnoy-package.Rd

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