【问题标题】:Preview development R documentation预览开发 R 文档
【发布时间】:2017-01-10 14:37:40
【问题描述】:

我正在 RStudio IDE 中使用 devtoolsroxygen2 编写我的第一个 R 包。我遇到的问题与预览我“roxygenize” .R 文件时得到的 .Rd 文件有关。我正在使用 devtools::document() 来获取 .Rd 文件,但是当我尝试通过编写以下任何内容来预览帮助页面时:

help("FunctionName")
?FunctionName

控制台显示消息“将开发文档用于...”,但帮助窗口中有一个空白区域。使用devtools:load_all() 会导致同样的问题。也许这与devtools 在环境中加载包的方式有关,但既不是文档“Writing R Extensions”(预计不会参考使用roxygen),也不是书“R 包”由Hadley Wickham 提供了一个可行的解决方案。

【问题讨论】:

  • 建好后能用吗?
  • 如果我生成文档,构建 .tar 文件,安装它并库包,仍然存在同样的问题。我通常关闭并重新打开 RStudio 以使事情正常进行。但是,仅预览 .Rd 文件是一项非常繁琐的任务。
  • @Servadac 你还有这个问题吗?
  • 我找到的解决方案是 Build & Reload the package ,带有 RStudio 按钮,需要更多时间并且对调试代码没有那么有用。当我写这个问题时,我不知道 RStudio 有这个功能。

标签: r documentation devtools roxygen2


【解决方案1】:

project options 下的 Rstudio 中有一个 generate documentation with roxygen item - 检查它。

然后点击 Configure... 并选中如下框:

现在,每次您按 Ctrl+Shift+B 时,您的 doc 文件都会重新生成,您可以通过单击函数名称并按 F1 或在控制台中键入以下行之一来浏览它们:

?my_function
help(my_function)

【讨论】:

  • 有没有办法通过代码而不是 GUI 来实现?谢谢
猜你喜欢
  • 2021-10-06
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2014-07-14
  • 1970-01-01
  • 2013-01-01
  • 2016-01-03
相关资源
最近更新 更多