如何在RStudio中根据指定R包和addin名称获取其调用的函数

实现原理 #

RStudio的addin配置全部存储在对应包安装目录下的inst/rstudio/addins.dcf文件中，配置文件的Name字段对应addin的前端显示名称，Binding字段对应addin实际触发调用的函数名，只需要读取该配置文件做字段匹配即可实现需求。

完整函数代码 #

magic <- function(pkg, addin_name, return_fun = FALSE) {
  # 定位目标包的addin配置文件路径
  dcf_path <- system.file("rstudio/addins.dcf", package = pkg)
  if (!file.exists(dcf_path)) {
    stop(sprintf("R包 %s 未提供addin配置文件", pkg), call. = FALSE)
  }
  # 读取DCF格式的配置文件转为数据框
  addin_df <- as.data.frame(read.dcf(dcf_path), stringsAsFactors = FALSE)
  # 匹配对应名称的addin
  target_addin <- addin_df[addin_df$Name == addin_name, ]
  if (nrow(target_addin) == 0) {
    stop(sprintf("R包 %s 中未找到名为 %s 的addin", pkg, addin_name), call. = FALSE)
  }
  # 提取绑定的函数名
  bind_fun <- target_addin$Binding
  # 按参数指定返回对应结果
  if (isTRUE(return_fun)) {
    # 从包命名空间提取函数对象，支持非导出的内部函数
    return(getFromNamespace(bind_fun, ns = pkg))
  } else {
    # 返回标准的三冒号调用格式字符串
    return(sprintf("%s:::`%s()`", pkg, bind_fun))
  }
}

使用示例 #

示例1：获取调用函数字符串 #

magic("reprex", "Reprex selection")

返回结果：

[1] "reprex:::`reprex_selection()`"

示例2：获取可直接调用的函数对象 #

# 获取函数对象
reprex_select_fun <- magic("reprex", "Reprex selection", return_fun = TRUE)
# 直接调用该函数，等价于点击addin按钮
reprex_select_fun()

注意事项 #

• 传入的addin_name需要和addin配置文件中Name字段的内容完全一致，包括大小写、特殊符号
• 函数不需要额外依赖，仅使用R基础函数即可运行
• 三冒号调用格式兼容包的导出函数和内部非导出函数，和手动查找的结果格式一致

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