使用 install_github 是否有必要首先创建文档以使 NAMESPACE 正确?
Using install_github is it necessary to create the documentation first for the NAMESPACE to be correct?
标题很长,真的把我想说的都说了。但是当制作一个 R 包并将其放在 github 上时,是否有必要在推送到 github 之前构建 roxygen 文档?否则,我在使用 devtools::install_github
时似乎会遇到问题,因为 NAMESPACE 未正确构建(如果尚未构建文档)。我问是因为不必在每个存储库中存储所有 .Rd 文件,而是在安装期间构建它们会很好。我在这里错过了什么吗?另外,每次重建它们时,.git
文件夹都会变得越来越大。
这让我困惑了一段时间,因为我有正在导出的函数 (@export
),但没有构建文档并且没有意识到这是必要的。
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::).
还应该期望包作者查看和测试文档文件 - 如果您不自己构建它们,您可能会包含各种拼写错误甚至是阻止它们构建的错误。您也应该 check
发送您的包裹,即使它不是发往 CRAN 的。不这样做意味着您正在发布未经测试的、可能是劣质的和错误的代码。
.Rd 文件很小,只需将它们放在你的 repo 中即可。
标题很长,真的把我想说的都说了。但是当制作一个 R 包并将其放在 github 上时,是否有必要在推送到 github 之前构建 roxygen 文档?否则,我在使用 devtools::install_github
时似乎会遇到问题,因为 NAMESPACE 未正确构建(如果尚未构建文档)。我问是因为不必在每个存储库中存储所有 .Rd 文件,而是在安装期间构建它们会很好。我在这里错过了什么吗?另外,每次重建它们时,.git
文件夹都会变得越来越大。
这让我困惑了一段时间,因为我有正在导出的函数 (@export
),但没有构建文档并且没有意识到这是必要的。
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::).
还应该期望包作者查看和测试文档文件 - 如果您不自己构建它们,您可能会包含各种拼写错误甚至是阻止它们构建的错误。您也应该 check
发送您的包裹,即使它不是发往 CRAN 的。不这样做意味着您正在发布未经测试的、可能是劣质的和错误的代码。
.Rd 文件很小,只需将它们放在你的 repo 中即可。