如何用'?my_package_name'加载自己写的包文档？

Question

我用 R 做了一个包，叫做 "my_package_name"。当我运行?my_package_name或??_my_package_name时，都没有找到结果。我希望加载帮助文件的方式与 ?ggplot2 加载包帮助文件的方式相同。

我可以运行 ?my_function_name 获取我的函数的帮助文件。但是，这不适用于我的包名称，即使描述文件是完整的。我发现 help(package = my_package_name) 加载了一个包含描述文件和帮助页面的页面，但我想加载一个包含 ?my_package_name.

的页面

Answer 1

我想说最简单的方法可能是 运行 usethis 包中的以下内容。它将创建包含您的包文档所需的文件

usethis::use_package_doc()

我建议阅读该函数的文档以了解幕后发生的事情。