r - 包名称 = 主函数名称时的文档

Question

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

我不想重命名该函数，因为它简洁地传达了包的用途。在这种情况下，最佳做法是什么？打字应该? slidify导致功能文档还是包文档？

任何想法将不胜感激。

Answer 1

我会制作一个“slidify-package.Rd”文件，（或一个只有 roxygen 注释块的“slidify-package.R”文件）

?slidify应该指向函数文档，并且slidify?package应该指向包文档，并且两个帮助页面都应该有一个指向另一个的链接（例如，在 seealso 部分中）