是否可以/建议跳过roxygen使用roxygen2？

Question

最近有人向我介绍了Roxygen，以解决我的文档困境/懒惰。但是又出现了这个闪亮的Roxygen2，据我所知，它有点独立。Hadley的package工具需要使用Roxygen2，但似乎没有什么详细教程。

考虑到我要从头开始学习：

1. 有没有用例，对于新用户而言，Roxygen比Roxygen2更好，还是Roxygen2在所有方面都更优秀？

2. 如果有，有哪些学习资源可用（最好不需要先掌握Roxygen的知识）？

3. Roxygen2是否向后兼容Roxygen（这样投入学习和编写Roxygen的时间是否能延续）？

- Ari B. Friedman

---

我在这里看不到有用的问题。如果你需要非正式的讨论，或许你应该考虑聊天室。 - Dirk Eddelbuettel

也许可以将问题重新表述为：对于新用户而言，是否存在某些使用情境更适合使用roxygen而不是roxygen2？或者说，roxygen2在所有方面都比roxygen更好吗？ - Iterator

roxygen2 就像 ggplot2 对应于 ggplot 一样。当作者对 roxygen 进行了重大更新/改进时，他们将其作为一个新的软件包发布，而不是更新许多人使用的 roxygen。你编写源文件的方式基本上是相同的。 - Gavin Simpson

@Kevin：你的回答，连同Hadley的回答和Gavin的评论，正是我所期望的。你能把你的回答评论变成一个实际的回答吗？ - Ari B. Friedman

Answer 1

如果从头开始，没有理由偏向roxygen而不是roxygen2。我们正在为R新闻撰写一篇入门文章。

- hadley

Answer 2

我将我的构建脚本从roxygen更改为roxygen2，一切都像以前一样工作，只是现在我得到了一个漂亮的自动生成的NAMESPACE文件。

因此，学习roxygen意味着你正在学习roxygen2的基础知识。我确定我没有使用所有新功能，但对于基础的roxygen2与roxygen的使用方式相同。

我还要补充的是，devtools包中的install_github()（也在github上）绝对棒。对于不适合CRAN的软件包，github是一个很好的选择。

- kmm