r - 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)

我究竟做错了什么？我不太明白我是否输入了错误的输入，或者我在错误的地方输入了它（现在我正在使用控制台）。

谢谢

标签： rpackagedocumentationroxygen

Answer 1

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

它将创建您的软件包帮助文件，然后您可以方便地编辑它。