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

loveR

promptMethods(methods)
promptMethods()所属R语言包：methods

                                         Generate a Shell for Documentation of Formal Methods
                                         产生一个形式化方法的文档壳牌

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

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

Generates a shell of documentation for the methods of a generic function.
外壳的文件生成一个泛型函数的方法。


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


promptMethods(f, filename = NULL, methods)



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

参数：f
a character string naming the generic function whose methods are to be documented.
一个字符串，命名的通用功能，其方法是将记录。


参数：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 the coded topic name for these methods (currently, f followed by "-methods.Rd").  Can also be FALSE or NA (see below).
通常，一个连接或给予的外壳应书面文件的文件名字符串。默认对应这些方法编码的主题名称（目前，f其次"-methods.Rd"）。也可以是FALSE或NA（见下文）。


参数：methods
Optional methods list object giving the methods to be documented.  By default, the first methods object for this generic is used (for example, if the current global environment has some methods for f, these would be documented).  If this argument is supplied, it is likely to be getMethods(f, where), with where some package containing methods for f.
可选的方法列表对象记录的方法。默认情况下，第一个方法，使用这个通用的对象（例如，如果目前的全球环境有一些方法f，这些将被记录）。如果这种说法是提供的，它很可能是getMethods(f, where)，where一些包包含f方法。


Details

详情----------Details----------

If filename is FALSE, the text created is returned, presumably to be inserted some other documentation file, such as the documentation of the generic function itself (see prompt).
如果filename是FALSE，创建的文本返回，据推测，如泛型函数本身的文档插入其他一些文档文件，（见prompt）。

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

Otherwise, the documentation shell is written to the file specified by filename.
否则，文件的外壳被写入到filename指定的文件。


值----------Value----------

If filename is FALSE, the text generated; if filename is NA, a list-style representation of the documentation shell. Otherwise, the name of the file written to is returned invisibly.
filename如果是FALSE，生成文本; filename如果NA，一个列表文件壳式表示。否则，写入该文件的名称返回无形。


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

Software for Data Analysis: Programming with R Springer.  (For the R version.)
Programming with Data Springer (For the original S4 version.)

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

prompt and promptClass
prompt和promptClass

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


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