整个包的 R 包帮助

Question

当给出命令

base

或

help("base")

时，某些软件包（例如

?base

）会显示描述该软件包的帮助页面。

当使用

roxygen2

创建文档时，如何在创建包时完成此操作？

Answer 1

请参阅 Hadley Wickham 和 Jennifer Bryan 撰写的 R 包 (2e) 的这一章：包的文档/函数文档/帮助主题。

我们建议调用

usethis::use_package_doc()

在虚拟文件

R/{pkgname}-package.R

中设置此包级文档，其内容如下所示：

#' @keywords internal 
"_PACKAGE"