使用install_github是否需要首先为NAMESPACE创建文档才能正确？

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

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

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

是.文档,NAMESPACE文件,这些都是完整的可安装包的一部分.

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

这将假设每个人都使用roxygen2构建.Rd文件,但这roxygen是一个相对较新的开发,并不是必需的 - 过去常常用手写.Rd文件(:: shudder ::).

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

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