Can Roxygen ignore non-user functions?

喜欢而已 提交于 2019-11-30 13:03:36

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.

This is on their to do list - in the next version, only functions with roxygen documentation will create man files.

Use the internal keyword field (i.e. @keywords internal) to remove the function from the documentation and make it available for experienced users only. Source: roxygen2 vignette.

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!