R语言:prompt()函数中文帮助文档(中英文对照)

loveR

prompt(utils)
prompt()所属R语言包：utils

                                        Produce Prototype of an R Documentation File
                                         生产的R文档文件的原型

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

Facilitate the constructing of files documenting R objects.
方便的记录R对象的文件的建设。


用法----------Usage----------


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, ...)



参数----------Arguments----------

参数：object
an R object, typically a function for the default method.  Can be missing when name is specified.
R对象，通常是默认的方法函数。可以missing时name指定。


参数：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.
一个字符串，指定对象的名称。


参数：force.function
a logical.  If TRUE, treat object as function in any case.
一个逻辑。如果TRUE，把object在任何情况下的功能。


参数：...
further arguments passed to or from other methods.
通过进一步的论据或其他方法。


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.  For function objects, this shell contains the proper function and argument names.  R documentation files thus created still need to be edited and moved into the "man" subdirectory of the package containing the object to be documented.
除非filename是NA，一个文档壳object是书面到filename指定的文件，并给予有关此消息。这个shell函数对象，包含适当的功能和参数名。 R中由此产生的文件仍然需要编辑和移动到man子目录包含被记录的对象包。

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是列表式的代表性。

When prompt is used in for loops or scripts, the explicit name specification will be useful.
当promptfor循环或脚本，明确name规范将是有益的。


值----------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，文档壳的列表风格的代表。否则，写入该文件的名称返回无形。


警告----------Warning----------

The default filename may not be a valid filename under limited file systems (e.g. those on Windows).
默认的文件名可能不是一个有效的文件名，在有限的文件系统（例如Windows上）。

Currently, calling prompt on a non-function object assumes that the object is in fact a data set and hence documents it as such.  This may change in future versions of R.  Use promptData to create documentation skeletons for data sets.
目前，调用prompt假设一个非函数对象的对象实际上是一个数据集，因此文件等。这可能在未来版本R.使用promptData创建数据集文件的骨骼改变。


注意----------Note----------

The documentation file produced by prompt.data.frame does not have the same format as many of the data frame documentation files in the base package.  We are trying to settle on a preferred format for the documentation.
文档文件prompt.data.frame不具备的许多数据框base包中的文档文件的格式相同。我们正试图解决一个文档的首选格式。


作者（S）----------Author(s)----------


Douglas Bates for <code>prompt.data.frame</code>



参考文献----------References----------

The New S Language. Wadsworth &amp; Brooks/Cole.

参见----------See Also----------

promptData, help and the chapter on &ldquo;Writing R documentation&rdquo; in &ldquo;Writing R Extensions&rdquo; (see the "doc/manual" subdirectory of the R source tree).
promptData，help“章”写R的文档“中的”写R扩展“（见”“doc/manual的R源代码树的子目录）。

For creation of many help pages (for a package), see package.skeleton.
为创造很多的帮助页面（包），请参阅package.skeleton。

To prompt the user for input, see readline.
提示用户输入，看到readline。


举例----------Examples----------


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:[＃创建一个函数每个的GlobalEnv的帮助文件。]
for(f in ls()) if(is.function(get(f))) prompt(name = f)

## End(Not run)[＃结束（不运行）]


转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。