包名称=主要功能名称时的文档

时间:2012-11-06 15:36:51

标签: r

我正在写一个R包名slidify。包中的主要功能也称为slidify。当我运行devtools::check时,我收到一条警告,指出Rd文件中存在冲突。

我不想重命名该功能,因为它简单地传达了包的目的。在这种情况下,最佳做法是什么?键入? slidify是否应该导致功能文档或包文档?

任何想法都会受到赞赏。

1 个答案:

答案 0 :(得分:4)

我会制作一个“slidify-package.Rd”文件,(或“slidify-package.R”文件,只有roxygen注释块)

?slidify应该导致函数文档,slidify?package应该导致包文档,并且两个帮助页面都应该有一个指向另一个的链接(例如,在seealso部分)