CRAN提交 - 我应该如何记录R中的隐藏功能?

时间:2018-02-10 03:29:35

标签: r devtools cran roxygen2

长话短说:

我的目标是向CRAN提交一份用roxygen2开发的R软件包,我需要找到一些关于编写和记录隐藏函数的指南。

更多详情:

我在Rstudio中使用roxygen2编写我的第一个R包。我已经记录了到目前为止我写的所有函数,以便我的协作者可以在进入脚本的详细信息之前轻松地理解它们的用途。所有对用户无用但对包必要的函数不会在命名空间中导出,而是从包手册/索引(@keywords internal)中删除。与此同时,我的合作者仍然可以在Rstudio的帮助下阅读他们的文档。

最后,我想从帮助中删除这些“隐藏功能”的文档,因为没有理由保留它。我正在考虑遵循我在其他帖子中找到的建议,即在#'创建的文档中使用##更改roxygen2。但是,我不确定这是否是正确的实施步骤,如果删除帮助和手册中的功能文档与CRAN要求兼容。

有人能指出一些与此问题相关的指导方针,或者有任何分享经验吗?

0 个答案:

没有答案