Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Can Roxygen ignore non-user functions?

Tags:

r

roxygen

I've just started playing around with the roxygen package and I've very happy with the results so far. However I was wondering, is there a way to specify to roxygen that it should ignore certain functions that are not user-accessible?

Specifically, I'd rather not have a .Rd file pop up because I'm using the .onLoad() hook in my package. This function is already documented in the base package so there's no reason for me to re-document it.

like image 755
Sharpie Avatar asked Feb 23 '10 05:02

Sharpie


1 Answers

Well, I finally found and browsed the Roxygen-devel list at R-forge to see when this would be implemented, and it appears to already be in the version of Roxygen that is on CRAN. The key is to specify use.Rd2=TRUE when calling roxygenize(). Under this mode, Roxygen will skip creating documentation for any functions that are not preceded by Roxygen comments.

like image 151
Sharpie Avatar answered Oct 23 '22 23:10

Sharpie