r - 是否可以/建议跳过 roxygen 以支持 roxygen2？

Question

很难说出这里问的是什么。这个问题模棱两可、含糊不清、不完整、过于宽泛或言辞激烈，无法以目前的形式合理回答。如需帮助澄清此问题以便可以重新打开，visit the help center .




10年前关闭。




我最近被指向 Roxygen 来解决我的文档问题/懒惰。但是还有这个 Shiny 的 Roxygen2，据我所知，它有点像它自己的东西。 Hadley 的打包工具需要使用 Roxygen2，但在任何地方都没有太多的演练方式。

鉴于我在学习过程中从头开始:

对于新用户，是否有一个用例更喜欢 Roxygen 而不是 Roxygen2，或者 Roxygen2 在所有方面都更好？

如果是这样，有哪些资源可以学习它(最好是那些不依赖于 Roxygen 的先验知识的资源)？

Roxygen2 是否与 Roxygen 向后兼容(这样在学习和编写 Roxygen 上投入的时间会延续)？

Answer 1

我将我的构建脚本切换为调用 roxygen2 而不是 roxygen，一切都像以前一样工作，只是现在我得到了一个很好的自动生成的 NAMESPACE 文件。

所以学习roxygen意味着你正在学习roxygen2的基础知识。我确定我没有使用所有新功能，但对于基础知识，roxygen2 的工作方式与 roxygen 一样。

我还要补充一点 install_github()在 devtools包 ( also on github ) 绝对很棒。对于不适合 CRAN 的软件包，github 是一个不错的选择。