如何为新功能的帮助页面创建存根?

How do I create the stub for a help page for a new function?

我写了一些 R 代码,运行 package.skeleton(),编辑了 man/ 目录中的帮助页面,构建并发布了包。

现在我正在开发版本 2 并向代码中添加一些功能。 如何为他们的帮助页面创建存根? 如果我 运行 package.skeleton(force=TRUE),它会破坏 man/ 中的帮助页面 我已经为版本 1 编辑了.

当然可以备份man/目录,然后运行package.skeleton(force=TRUE),再复制备份到man/,最后编辑剩下的新建存根...但是没有更简单的方法吗?我查看了 "Writing R extensions",但没有找到任何东西。


MWE:

  1. 对于版本 1,我们的文件 code_file.R 包含一行:

    foo <- function() print("foo")
    
  2. 我们运行

    package.skeleton(name="test",code_files="code_file.R")
    

    创建存根文件 test/man/foo.Rd.

  3. 我们编辑test/man/foo.Rd。 (我们构建并发布包,此处无关。)

  4. 对于版本 2,我们将以下行添加到 code_file.R

    bar <- function() print("bar")
    
  5. 现在,我们如何在不破坏现有 test/man/foo.Rd 的情况下获得 test/man/bar.Rd 的存根?

您可以使用 utils::prompt() 创建框架帮助页面。有关完整详细信息,请参阅 ?prompt 上的文档。