CODEWITHSUNDEEP
rpackagetravis-circpp
Malith
Malith

Reputation: 805

Rcpp integrated with R package: Documentation of CPP code objects

I have been developing a package with Rcpp for C++ integration. I used RcppExport to make the functions return SEXP objects.

The issue is travis-ci seems to give warnings telling that there are undocumented code objects. (These are cpp functions). However I do not want users to directly access those functions as well.

How can I resolve this issue? How can I document these functions as well?

Upvotes: 0

Views: 260

Answers (1)

Dirk is no longer here
Dirk is no longer here

Reputation: 368231

You seem to have an elementary misunderstanding here.

If your NAMESPACE contains a wildcard 'export all' a la exportPattern("^[[:alpha:]]+") then each global symbol is exported and per R standards that are clearly documented needs a help entry.

One easy fix is NOT to export everything and just write documentation for what you want exported. We sometimes do that and call the Rcpp function something like foo_impl and then have R functions foo (with documentation) call foo_impl. In that case you would just export foo and all is good.

In short, you are confused about R packages and not so much Rcpp. I would recommend downloading the sources of a few (small) Rcpp packages to get a feel for what they do.

Upvotes: 3

Related Questions