R语言 SoDA包 promptAll()函数中文帮助文档(中英文对照)

loveR

promptAll(SoDA)
promptAll()所属R语言包：SoDA

                                         Create an outline of documentation for multiple objects
                                         创建多个对象的轮廓文档

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

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

Documentation in outline form will be generated to document together all the objects (typically functions) whose names are given.
以大纲形式将生成的文档文件连同所有对象（通常是函数）的名称。


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


promptAll(objects, name, filename, where, ...)



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

参数：objects
The names of the objects to be documented.  
被记录的对象的名称。


参数：name
The name for the documentation file; by default the name of the first of the objects is used.
的文档文件的名称;默认情况下，使用的第一对象的名称。


参数：filename
The file on which to save the outline of the documentation.  By default, appends ".Rd" to name.  
上的文件要保存的文件的轮廓。默认情况下，追加".Rd"到name。


参数：where
Optional environment where the objects will be found.  By default, uses the top level environment of the call to promptAll().
可选的环境中的对象会被发现。默认情况下，使用环境的调用promptAll()的顶层。


参数：...
Optional arguments to be passed on to prompt().
可选参数被传递给prompt()。


Details

详细信息----------Details----------

The function prompt() is called for each of the objects.  The usage and arguments sections of the individual documentation are merged.  In particular, all shared argument names will be listed only once in the documentation shell.
被称为用于每个对象的功能prompt()。 usage和arguments部分的个人文件进行合并。特别是，所有共享的参数名的文件shell中只列出一次。


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

Nothing useful.  Called for its side effect.
没什么用处。调用它的副作用。


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

packageAdd
packageAdd


实例----------Examples----------


## Not run: [＃不运行：]
promptAll(objects(pattern="tri*"), "triDiagonal")

## End(Not run)[＃（不执行）]

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


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