promptData(utils)
promptData()所属R语言包：utils
Generate Outline Documentation for a Data Set
生成一个数据集的大纲文档
译者：生物统计家园网 机器人LoveR
描述----------Description----------
Generates a shell of documentation for a data set.
生成数据集文件的shell。
用法----------Usage----------
promptData(object, filename = NULL, name = NULL)
参数----------Arguments----------
参数：object
an R object to be documented as a data set.
R对象被记录为一组数据。
参数：filename
usually, a connection or a character string giving the name of the file to which the documentation shell should be written. The default corresponds to a file whose name is name followed by ".Rd". Can also be NA (see below).
通常，一个连接或给予的外壳应书面文件的文件名字符串。默认对应一个文件，其名称是，name".Rd"其次。也可以NA（见下文）。
参数：name
a character string specifying the name of the object.
一个字符串，指定对象的名称。
Details
详情----------Details----------
Unless filename is NA, a documentation shell for object is written to the file specified by filename, and a message about this is given.
除非filename是NA，一个文档壳object是书面到filename指定的文件，并给予有关此消息。
If filename is NA, a list-style representation of the documentation shell is created and returned. Writing the shell to a file amounts to cat(unlist(x), file = filename, sep = "\n"), where x is the list-style representation.
如果filename是NA，文档壳的列表式表示创建并返回。 shell来编写一个文件，相当于cat(unlist(x), file = filename, sep = "\n")，其中x是列表式的代表性。
Currently, only data frames are handled explicitly by the code.
目前，只有数据框的处理明确的代码。
值----------Value----------
If filename is NA, a list-style representation of the documentation shell. Otherwise, the name of the file written to is returned invisibly.
如果filename是NA，文档壳的列表风格的代表。否则，写入该文件的名称返回无形。
参见----------See Also----------
prompt
prompt
举例----------Examples----------
promptData(sunspots)
unlink("sunspots.Rd")
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。
|
发表于 2012-2-16 21:13:25
