使用roxygen2开发R包时F1帮助页无法正常显示的问题

问题场景 #

我正在跟随roxygen2官方文档开发R包，在示例代码基础上添加了@export标记，代码如下：

#' Add together two numbers
#'
#' @param x A number.
#' @param y A number.
#' @return A number.
#' @export
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
  x + y
}

执行roxygenise()和devtools::load_all()后，能看到add是project包的函数，输入project::add()时会弹出悬浮提示“按F1查看更多信息”，但按下F1后显示：

No documentation for ‘add’ in specified packages and libraries:
you could try ‘??add’

不过使用?add可以正常打开帮助页，需要解决F1无法调出帮助页的问题。

解决步骤 #

1. 完整安装包到本地R库 #

devtools::load_all()仅临时加载包的函数，并未生成并安装完整的帮助文档索引。执行以下命令完成包的完整安装：

devtools::install()

安装完成后重启R会话，调用library(project)加载包，此时按F1即可正常调出add()的帮助页。

2. 确认DESCRIPTION文件配置正确 #

确保包的DESCRIPTION文件中已启用roxygen2文档生成：
打开DESCRIPTION，检查是否包含以下配置（版本号可根据你安装的roxygen2调整）：

Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3

若未添加，手动补充后重新执行roxygenise()，再执行安装命令。

3. 刷新RStudio帮助索引（可选） #

若安装后F1仍无效，可通过以下方式触发索引刷新：

• 点击RStudio顶部菜单栏Tools -> Check for Package Updates（无需实际更新，仅触发索引同步）
• 或直接重启RStudio，让IDE重新读取本地库的帮助文档索引。

补充说明 #

?add能正常工作是因为它直接读取了包man目录下roxygen2生成的本地文档，而IDE的F1功能依赖于本地R库中已安装包的帮助索引，因此必须完成完整安装才能让F1生效。

内容的提问来源于stack exchange，提问作者David Robie