我试图通过help()或?函数获得实际包(而不是它的函数，因为这是在记录包时自动完成的)的文档。
例如:
?dplyr
我们得到:
dplyr-package {dplyr} R Documentation
dplyr: A Grammar of Data Manipulation
Description
To learn more about dplyr, start with the vignettes: browseVignettes(package = "dplyr")
Author(s)
Maintainer: Hadley Wickham hadley@rstudio.com (ORCID)
Authors:
Romain François (ORCID)
Lionel Henry
Kirill Müller (ORCID)
Other contributors:
RStudio [copyright holder, funder]
See Also
Useful links:
https://dplyr.tidyverse.org
https://github.com/tidyverse/dplyr
Report bugs at https://github.com/tidyverse/dplyr/issues
[Package dplyr version 1.0.7 Index]
我创建了一个基本包，cats，通过希拉里帕克的教程:https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/。我安装了它，并确认它可以正常工作，例如，获取一个功能的帮助文档:
?cat_function
给:
cat_function {cats} R Documentation
A Cat Function
Description
This function allows you to express your love of cats.
Usage
cat_function(love = TRUE)
Arguments
love
Do you love cats? Defaults to TRUE.
Examples
cat_function()
[Package cats version 0.0.0.9000 Index]
但是，尝试获取包本身的文档:
?cats
No documentation for ‘cats’ in specified packages and libraries:
you could try ‘??cats’
从功能帮助中，我可以点击Index，然后我得到一个确定的"帮助";页，我也可以从那里点击DESCRIPTION file，但这些绝对不像help(cats)会输出。
我如何为我的cats包获得相同的help()调用?我想我一定读过所有关于创建包的教程，但只看到了一些关于添加小插图的东西，这似乎是不同的事情(尽管我确实尝试添加小插图，但帮助文档仍然没有出现)。我也尝试添加一个自述文件，但是，唉，同样的结果。诀窍是什么?=)
编辑:实际上一直在使用usethis到devtools来安装和document()，但我不认为这会有什么不同，因为我没有在任何教程中看到这种特殊形式的软件包文档。
既然您使用的是usethis，那么您可以使用usethis::use_package_doc()。
你也可以阅读Hadley关于R包的书，它解释了这是怎么做的。