R中的函数旨在对最终用户不可见

时间:2012-09-26 16:36:48

标签: r package

在构建R包时,我写了几个函数,但其​​中一些并不是很重要,所以我打算不记录它们,并且它们对最终用户是不可见的。但是,我在我的示例部分中使用了这些函数,因此它们必须包含在包中(但不包含在帮助文档列表中)。我不知道该怎么做。我需要:

  1. 删除该功能的文档(在Emacs中,不使用C-c C-o),以便roxygenize不会生成.Rd文件?

  2. 仍然写了文档,但没有@export?

  3. 非常感谢!

2 个答案:

答案 0 :(得分:5)

如果不导出这些函数,则需要使用三重冒号结构调用它们:

myPkg:::myHiddenFn   

在某些基础和“必需”包帮助页面中有一些示例。

答案 1 :(得分:0)

谢谢大家的建议!是的,我将在包中导出我的功能。我问这个问题的原因是我看到一些包作者写了函数,但其​​中一些只能通过pkgName:::funName访问。我认为它也不好,但只是好奇人们如何实现这一点:)