r - 使用 install_github 是否有必要首先创建文档以使 NAMESPACE 正确？

Question

标题很长，真的把我想说的都说了。但是在制作R包并放在github上时，是否需要在推送到github之前先构建roxygen文档？否则，我在使用 devtools::install_github 时似乎会遇到问题，因为 NAMESPACE 未正确构建(如果尚未构建文档)。我问是因为不必在每个存储库中存储所有 .Rd 文件，而是在安装期间构建它们会很好。我在这里错过了什么吗？另外，每次重建时，.git 文件夹都会变得越来越大。

这让我困惑了一段时间，因为我有正在导出的函数 (@export)，但没有构建文档，也没有意识到这是必要的。

Answer 1

is it necessary to build the roxygen documentation prior to pushing to github

是的。文档、 namespace 文件，这些都是完整的可安装包的一部分。

it would be nice to not have to store all the .Rd files in each repository, but instead build them during install

这假设每个人都使用 roxygen2 来构建 .Rd 文件，但是 roxygen 是一个相对较新的开发并且不是必需的 - 它曾经很常见地编写 .Rd 手动文件 (::shudder::).

还应该预料到文档文件会被包作者查看和测试 - 如果您不自己构建它们，您可能会包含各种错别字甚至是根本无法构建它们的错误。您还应该检查您的包裹，即使它不是发往 CRAN 的。不这样做意味着您正在发布未经测试的、可能是劣质的和有错误的代码。

.Rd 文件很小，只需将它们放在您的 repo 中即可。