使用devtools构建基础R包时手册不显示作者信息的问题
使用devtools构建基础R包时手册不显示作者信息的问题
嗨,我之前也碰到过一模一样的情况!其实问题出在:默认情况下,devtools::build_manual()生成的PDF手册不会自动把DESCRIPTION里的Authors@R内容提取到手册中,你需要给包添加一个包级的帮助文档,让roxygen2知道要把作者信息包含进去。
具体可以按这几步操作:
- 在你的包的
R目录下新建一个文件,命名规则是{你的包名}-package.R(比如你的包叫helloworld,就命名为helloworld-package.R),内容参考如下:
#' @title Hello World Demo Package #' @description 一个仅包含Hello World函数的基础演示包 #' @details 用于测试devtools包构建流程的极简示例 #' @author Jon Snow \email{jon.snow@gmail.com} #' @docType package #' @name helloworld-package NULL
这里的关键是@docType package标签(告诉roxygen2这是包级整体文档)和@author标签(明确指定作者信息)。
运行
devtools::document()更新包的帮助文档,这一步会把刚才写的包级文档转换成.Rd格式的帮助文件,供后续生成手册调用。重新执行你之前的构建流程:
devtools::build(); devtools::install(); devtools::build_manual()
这样生成的PDF手册里,就会在包的整体介绍板块显示出作者信息啦!
另外提个小建议:DESCRIPTION里的License字段现在是占位符,最好换成实际的许可证(比如用use_mit_license()生成后,License会变成MIT + file LICENSE),虽然这不是导致作者不显示的原因,但规范一点总是好的~
备注:内容来源于stack exchange,提问作者G. Ander
相关产品推荐
相关产品推荐

