R语言生成R文档文件的原型promptImport()函数-中英文对照帮助文档
By MicroRbt Martinez PhD
R语言函数名:promptImport()
R语言函数功能:生成R文档文件的原型
来自资源库:基础库(R语言自带)
promptImport()函数所属R语言包:所在R包具体名称、包功能的中英文双语描述见正文后面'--所在R语言包信息--'部分。
描述-----Description-----
Facilitate the constructing of files documenting R objects.
便于构造记录R对象的文件。
使用方法-----Usage-----
prompt(object, filename = NULL, name = NULL, ...)
## Default S3 methodefault S3 method:
默认的S3方法:
prompt(object, filename = NULL, name = NULL,
force.function = FALSE, ...)
## S3 method for class 'data.frame' S3 method for class 'data.frame'
prompt(object, filename = NULL, name = NULL, ...)
promptImport(object, filename = NULL, name = NULL,
importedFrom = NULL, importPage = name, ...)
参数-----Arguments-----
参数object介绍: an R object, typically a function for the default method. Can be missing when name is specified.
一个R对象,通常是默认方法的函数。指定name时可以为missing。
参数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.
传入或传出其他方法的其他参数。
参数importedFrom介绍: a character string naming the package from which object was imported. Defaults to the environment of object if object is a functi
-----未完,待续-----,↓↓↓展开剩余72%↓↓↓
|