You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

R包开发求助:使用?运算符无法调出包描述文件文档

解决R包无法通过?查看文档的问题
  • 确认包目录结构合规:必须有R/文件夹存放函数脚本,man/文件夹(若不存在,devtools::document()会自动创建,但前提是有正确的roxygen注释)
  • 检查函数的roxygen注释:每个需要对外暴露的函数,开头必须包含规范的roxygen注释,至少要有@export标签才能被导出并生成文档,示例:
#' 计算两数之和
#'
#' 用于计算两个数值的求和结果
#' @param x 第一个输入数值
#' @param y 第二个输入数值
#' @return 返回两数之和
#' @export
add <- function(x, y) {
  x + y
}
  • 确保工作目录是包根目录:运行devtools::document()前,用setwd("你的包根路径")切换,或者在RStudio中打开包项目
  • 重新生成文档并安装:
    1. 运行devtools::document(),检查man/文件夹是否生成对应的.Rd文件(若未生成,说明roxygen注释格式有误)
    2. 执行devtools::install()(或RStudio中点击「Build」→「Install and Restart」),加载包后用?函数名查看文档
  • 若要查看包的整体文档:
    在R/目录下的某个脚本中添加如下roxygen注释,再重新生成文档并安装:
#' @keywords internal
"_PACKAGE"
#' 自定义R包
#'
#' 这里填写包的整体功能描述
#' @docType package
#' @name 你的包名-package
NULL

之后就能用?你的包名查看包的整体文档了

内容的提问来源于stack exchange,提问作者Steal

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.06 12:47:35