R包easyalgorithms已写roxygen函数文档却无法查询包级文档求助
问题原因
你遇到的报错核心有两个:
- 仅为包内函数编写了roxygen文档,没有生成包级别的帮助文档,R无法匹配到
easyalgorithms对应的包帮助条目 - 你执行的
packages?easyalgorithms存在拼写错误,正确的包文档查询语法是单数形式的package?easyalgorithms,但即便语法正确,没有配置包级别文档的前提下还是会触发报错
解决步骤
- 在R包项目根目录的
R/文件夹下新建独立的roxygen配置文件,通常命名为easyalgorithms-package.R,写入以下内容:
#' @keywords internal "_PACKAGE" #' easyalgorithms: 此处填写你的包的功能简介 #' #' 此处填写包的详细说明,比如包含的算法类型、适用场景、依赖环境等内容 #' @docType package #' @name easyalgorithms NULL
- 执行
devtools::document()重新生成全量帮助文档 - 本地开发测试可以直接运行
devtools::load_all()加载当前开发版本的包,正式使用需要重新安装更新后的包 - 加载完成后执行
?easyalgorithms或者package?easyalgorithms均可正常调出包级别的帮助文档
内容的提问来源于stack exchange,提问作者OLGJ
相关产品推荐
相关产品推荐

