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

Question

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

这让我很困惑，因为我有导出的功能（@export），但没有构建文档，也没有意识到这是必要的。

Answer 1

  

是否有必要在推送到github之前构建roxygen文档

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

  

不必将所有.Rd文件存储在每个存储库中，而是在安装期间构建它们

这假设每个人都使用roxygen2来构建.Rd文件，但是roxygen是一个相对较新的开发，并不是必需的 - 过去常见的是编写.Rd个文件手（ :: shudder :: ）。

还应该期望文档文件由包作者查看和测试 - 如果你不自己构建它们，你可能包括各种错别字甚至是阻止它们构建的错误。你应该check你的包裹，即使它不是用于CRAN。不这样做意味着你要提供未经测试的，可能是粗制滥造和错误的代码。

.Rd文件很小，只需将它们放入您的仓库。