R prompt 生成 R 文档文件的原型

说明

促进文件记录的构建R对象。

用法

prompt(object, filename = NULL, name = NULL, ...)

## Default S3 method:
prompt(object, filename = NULL, name = NULL,
       force.function = FALSE, ...)

## S3 method for class 'data.frame'
prompt(object, filename = NULL, name = NULL, ...)

promptImport(object, filename = NULL, name = NULL, 
	importedFrom = NULL, importPage = name, ...)

参数

object	一个R对象，通常是默认方法的函数。可missing当name被指定。
filename	通常，connection 或字符串给出应写入文档 shell 的文件名。默认对应于名称为 name 后跟 ".Rd" 的文件。也可以是NA(见下文)。
name	指定对象名称的字符串。
force.function	一个合乎逻辑的。如果 TRUE ，则在任何情况下都将 object 视为函数。
...	传入或传出其他方法的进一步参数。
importedFrom	命名从中导入 object 的包的字符串。如果 object 是函数，则默认为 object 环境。
importPage	命名包中帮助页面的字符串，从中导入 object。

细节

除非filename是NA，一个文档 shell object写入指定的文件filename，并给出有关此的消息。对于函数对象，此 shell 包含正确的函数和参数名称。由此创建的 R 文档文件仍然需要编辑并移动到‘男人’包含要记录的对象的包的子目录。

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

当 prompt 用于 for 循环或脚本中时，显式 name 规范将很有用。

importPage论证promptImport需要给出原始帮助页面的帮助文件名称的基数。例如，approx函数记录在‘approxfun.Rd' 在里面stats包，所以如果它被导入并重新导出它应该有importPage = "approxfun"。从其他包导入的对象通常不会被记录，除非重新导出。

值

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

警告

默认文件名在有限的文件系统(例如 Windows 上的文件系统)下可能不是有效的文件名。

目前，正在调用prompt在非函数对象上假设该对象实际上是一个数据集，因此将其记录为数据集。这可能会在未来版本中改变R.采用promptData为数据集创建文档框架。

注意

prompt.data.frame 生成的文档文件与 base 包中的许多数据帧文档文件的格式不同。我们正在尝试确定文档的首选格式。

例子

require(graphics)

prompt(plot.default)
prompt(interactive, force.function = TRUE)
unlink("plot.default.Rd")
unlink("interactive.Rd")

prompt(women) # data.frame
unlink("women.Rd")

prompt(sunspots) # non-data.frame data
unlink("sunspots.Rd")


## Not run: 
## Create a help file for each function in the .GlobalEnv:
for(f in ls()) if(is.function(get(f))) prompt(name = f)

## End(Not run)

作者

Douglas Bates for prompt.data.frame

参考

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) The New S Language. Wadsworth & Brooks/Cole.

也可以看看

promptData,help以及“编写 R 扩展”中的“编写 R 文档”一章(请参阅“文档/手册’的子目录R源树)。

要创建许多帮助页面(针对包)，请参阅 package.skeleton 。

要提示用户输入，请参阅 readline 。