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

标签 r package

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

  • 删除该函数的文档(在 Emacs 中,不使用 C-c C-o)所以 roxygenize 不会生成 .Rd 文件?
  • 仍然编写文档,但没有@export?

  • 非常感谢!

    最佳答案

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

    myPkg:::myHiddenFn   
    

    在一些基本和“必需”包帮助页面中有一些这样做的例子。

    关于r - R 中的函数旨在对最终用户不可见,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12606420/

    相关文章:

    json - R 管道工 JSON 序列化程序 auto_unbox

    r - 如何在宽格式的data.frame上运行ANOVA?

    r - 从 R 中的十六进制输入获取单一颜色名称

    java - 获取包中声明的所有 Java 类的名称

    java - 在 Eclipse 中创建新的 Java 项目不会创建(默认)包?

    r - R CRAN 检查中的注意事项 -- * 检查顶级文件 ... 注意 如果未安装 ‘pandoc’,则无法检查文件 README.md

    java - 重命名一个项目应该这么难吗?

    r - 考虑到数据帧的顺序,如何匹配R中两个列表的元素

    r - 要写入的文本必须是长度为一的字符向量

    r - 使用 R 包分发已编译的可执行文件