R promptPackage 生成包文档的 Shell

说明

使用 Rd 宏生成包概述帮助页面的原型，该宏在构建包时动态地从包元数据中提取信息。

用法

promptPackage(package, lib.loc = NULL, filename = NULL,
              name = NULL, final = FALSE)

参数

package	character 字符串，其中包含要记录的包的名称。
lib.loc	被忽略。
filename	通常，connection 或字符串给出应写入文档 shell 的文件名。默认对应于名称为 name 后跟 ".Rd" 的文件。也可以是NA(见下文)。
name	指定帮助主题名称的字符串；默认为‘⁠<pkgname>-package⁠’，这是必需的⁠\alias⁠获取概述帮助页面。
final	一个逻辑值，指示是否尝试创建帮助主题的可用版本，而不仅仅是一个 shell。

细节

除非 filename 是 NA ，否则 package 的文档 shell 会写入 filename 指定的文件中，并给出相关消息。

如果 filename 是 NA ，则会创建并返回文档 shell 的列表样式表示形式。将 shell 写入文件相当于 cat(unlist(x), file = filename, sep = "\n") ，其中 x 是列表样式的表示形式。

如果 final 是 TRUE ，生成的文档将不包含用于手动编辑的 place-holder 插槽，它将按原样使用。在大多数情况下，手动编辑的文件是更好的选择(但 final = TRUE 的工作量肯定更少)。

值

如果 filename 是 NA ，则为文档 shell 的列表样式表示形式。否则，写入的文件名会以不可见的方式返回。

例子

filename <- tempfile()
promptPackage("utils", filename = filename)
file.show(filename)
unlink(filename)

也可以看看

prompt , package.skeleton