alittleboy alittleboy - 3 months ago 7
R Question

do not show function help document in building R package by roxygen2

I am using

devtools
to build R package, and there are some functions that are NOT designed to be visible to end-users. However, since these functions involve calling C codes by
.Call
, so that I have to write
@useDynLib
above the function for automatic generation of .Rd files. In that way, when I build the package, even I did NOT include the
@export
for those functions, they nonetheless appear in the help document... Is there a way to suppress those functions even if they have been documented? Thanks!

Answer

According to Hadley's comments, use @keywords internal will make the function invisible to end-users. Details can be found here in the wiki pages of devtools.