在roxygen2建立R包中不显示功能帮助文档 [英] do not show function help document in building R package by roxygen2

问题描述

我正在使用 devtools 来构建R软件包，并且有些功能并非旨在让最终用户看到。但是，由于这些函数涉及通过 .Call 调用C代码，因此我必须在函数上方编写 @useDynLib 用于自动生成.Rd文件。这样，当我构建软件包时，即使我没有为这些功能添加 @export ，它们仍会出现在帮助文档中...有没有办法即使已记录这些功能，还是禁止？谢谢！

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!

推荐答案

根据哈德利的评论，使用 @关键字内部将使该功能对最终用户不可见。可以在 devtools 此处中找到详细信息。 c>。

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.

这篇关于在roxygen2建立R包中不显示功能帮助文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！