【问题标题】:Can I generate comments using roxygen2 without building an R package? [duplicate]我可以在不构建 R 包的情况下使用 roxygen2 生成评论吗? [复制]
【发布时间】:2015-01-14 17:21:51
【问题描述】:

我需要为一组 R 程序生成文档。不幸的是,基于源代码构建包不是一种选择(我知道该怎么做,而且我已经尝试过 RStudio、roxygen2 和包,它就像一个魅力一样工作)。我可以使用 roxygen2 从 R 源代码生成文档,而无需以类似于 doxygen 如何与 C++ 一起使用的方式构建包吗?如果没有,是否还有其他选项可以记录不依赖包的 R 代码?

【问题讨论】:

  • 我很困惑,如果您不使用包(为什么不使用?),您将如何处理 Rd 文件?
  • @baptiste R CMD Rd2pdf 会从您的 Rd 文件中制作出精美的 PDF...
  • Rd 文件可以转换为 HTML 并保存到目录中,可能带有索引或目录。 C++ 的 Doxygen 在文件级别工作,不需要额外的结构(如本例中的 R 包)。我曾希望 R 中可能存在类似的东西。我无法构建包的原因是存在我不应该更改其目录结构的预先存在的代码。
  • 投了反对票 - 你能更清楚一点吗?是否类似于在不同的文件夹中而不是在包结构中拥有 R 函数?而且你不能因为代码太依赖文件夹结构而制作包?或者其他的东西?您的功能在哪里,您希望文档采用什么格式?您是否希望从help(foo) 访问它,其中foo 是您的功能之一?请解释更多,不要让我们猜测。
  • 好的,我只是在询问进一步的上下文(您应该在问题中包含这些内容)。如果您仔细查看 roxygen2::roxygenise,您可能会发现适用于文件级别的相关函数(roxygen2:::roc_process 似乎是一个强有力的候选者)。

标签: r roxygen2


【解决方案1】:

如果您只是在文档之后,devtools::document() 将构建文档文件而不构建包。

【讨论】:

  • 内部调用roxygen2::roxygenise,并采用标准包目录结构
  • 是的,但devtools::document 假定它在包结构中工作。
猜你喜欢
  • 2016-11-07
  • 1970-01-01
  • 1970-01-01
  • 2017-12-30
  • 2017-05-01
  • 2019-01-19
  • 1970-01-01
  • 1970-01-01
  • 2017-12-01
相关资源
最近更新 更多