R promptData 为数据集生成大纲文档

说明

生成数据集的文档 shell 。

用法

promptData(object, filename = NULL, name = NULL)

参数

object	一个R要记录为数据集的对象。
filename	通常，connection 或字符串给出应写入文档 shell 的文件名。默认对应于名称为 name 后跟 ".Rd" 的文件。也可以是NA(见下文)。
name	指定对象名称的字符串。

细节

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

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

目前，代码仅显式处理数据帧。

值

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

例子

promptData(sunspots)
unlink("sunspots.Rd")

也可以看看

prompt