R中的文档包

Question

我制作了一个 R 包并想记录它。我已经设法用 roxygen 为我的包 easyalgorithms 中包含的功能编写了文档，但是如果我在控制台中输入：

> ?easyalgorithms
No documentation for ‘easyalgorithms’ in specified packages and libraries:
you could try ‘??easyalgorithms’

我找到了这个指南：https://r-pkgs.org/man.html#man-packages 建议您键入 packages?foo。所以在我的例子中，我尝试了以下但它不起作用：

> packages?easyalgorithms
Error in (function (e1, e2)  : 
  no documentation of type ‘packages’ and topic ‘easyalgorithms’ (or error in processing help)

我做错了什么？我不太明白是我输入错误还是输入错误的地方（现在我正在使用控制台）。

谢谢

Answer 1

默认情况下不可用。最简单的是使用usethis::use_package_doc()，见?usethis::use_package_doc。

它将创建您的程序包帮助文件，然后您可以根据需要进行编辑。