【问题标题】:Is it possible/advisable to skip roxygen in favor of roxygen2? [closed]是否可以/建议跳过 roxygen 以支持 roxygen2? [关闭]
【发布时间】:2011-08-06 22:21:35
【问题描述】:

我最近被指向 Roxygen 来解决我的文档问题/懒惰。但是还有这个闪亮的 Roxygen2,在我的理解中,它在某种程度上是它自己的东西。 Hadley 的打包工具需要使用 Roxygen2,但似乎没有太多的地方可以通过。

鉴于我在学习过程中是从零开始的:

  1. 对于新用户,是否存在偏爱 Roxygen 而不是 Roxygen2 的用例,或者 Roxygen2 在各方面都更好?

  2. 如果是,有哪些资源可以学习它(最好是那些不依赖于 Roxygen 先前知识的资源)?

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

【问题讨论】:

  • 我在这里没有看到有用的问题。如果您需要非正式的闲聊,也许您应该考虑使用聊天室。
  • 也许将问题改写为:对于新用户,是否有一个用例偏爱 roxygen 而不是 roxygen2,或者 roxygen2 在所有方面都更好?
  • roxygen2 对 roxygen 就像 ggplot2 对 ggplot 一样。当作者大幅更新/改进 roxygen 时,他们没有更新许多人使用的 roxygen,而是将其作为新软件包发布。编写源文件的方式基本相同。
  • @Kevin:你的答案,连同 Hadley 的回答和 Gavin 的评论,正是我想要的。你能把你的回答评论变成一个实际的答案吗?

标签: r roxygen roxygen2


【解决方案1】:

如果从头开始,没有理由更喜欢 roxygen 而不是 roxygen2。我们正在为 r 新闻撰写介绍性文章。

【讨论】:

    【解决方案2】:

    我将构建脚本切换为调用 roxygen2 而不是 roxygen,一切正常,除了现在我得到了一个不错的自动生成的 NAMESPACE 文件。

    所以学习 roxygen 意味着你正在学习 roxygen2 的基础知识。我确定我并没有使用所有的新功能,但对于基础来说,roxygen2 就像 roxygen 一样工作。

    我还要补充一点,devtools 包 (also on github) 中的 install_github() 非常棒。对于不适合 CRAN 的软件包,github 是一个不错的选择。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多