undoc(tools)
undoc()所属R语言包:tools
Find Undocumented Objects
发现无证对象
译者:生物统计家园网 机器人LoveR
描述----------Description----------
Finds the objects in a package which are undocumented, in the sense that they are visible to the user (or data objects or S4 classes provided by the package), but no documentation entry exists.
发现包中的对象是无证,在某种意义上说,他们对用户是可见的(或数据对象或包所提供的S4类),但没有文件条目存在。
用法----------Usage----------
undoc(package, dir, lib.loc = NULL)
参数----------Arguments----------
参数:package
a character string naming an installed package.
一个字符串,命名已安装的软件包。
参数:dir
a character string specifying the path to a package's root source directory. This must contain the subdirectory "man" with R documentation sources (in Rd format), and at least one of the "R" or "data" subdirectories with R code or data objects, respectively.
一个字符串,指定包的根源目录的路径。这必须包含的子目录man与R文件来源(Rd格式),并至少有一个R或data子目录R代码或数据对象,分别。
参数:lib.loc
a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all libraries currently known. The specified library trees are used to search for package.
特征向量的研发图书馆的目录名,或NULL。默认值的NULL对应于目前已知的所有库。指定库树是用来搜索package。
Details
详情----------Details----------
This function is useful for package maintainers mostly. In principle, all user-level R objects should be documented.
此功能是有用的大多为包维护者。在原则上,所有用户级别的R对象应记录在案。
The base package is special as it contains the primitives and these do not have definitions available at code level. We provide equivalent closures in environments .ArgsEnv and .GenericArgsEnv in the base package that are used for various purposes: undoc("base") checks that all the primitives that are not language constructs are prototyped in those environments and no others are.
base包是特殊的,因为它包含的原语,这些没有定义代码级。我们提供的环境中,相当于封.ArgsEnv和.GenericArgsEnv中base包用于各种用途:undoc("base")检查,所有原语,是不是语言结构原型这些环境,并没有其他人。
值----------Value----------
An object of class "undoc" which is a list of character vectors containing the names of the undocumented objects split according to documentation type.
一个类的对象"undoc"这是一个字符向量,含有分裂根据文件类型的无证对象的名称列表。
There is a print method for nicely displaying the information contained in such objects.
有一个print很好地显示在这些对象中包含的信息的方法。
参见----------See Also----------
codoc, QC
codoc,QC
举例----------Examples----------
undoc("tools") # Undocumented objects in 'tools'[在“工具”中的无证对象]
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注:
注1:为了方便大家学习,本文档为生物统计家园网机器人LoveR翻译而成,仅供个人R语言学习参考使用,生物统计家园保留版权。
注2:由于是机器人自动翻译,难免有不准确之处,使用时仔细对照中、英文内容进行反复理解,可以帮助R语言的学习。
注3:如遇到不准确之处,请在本贴的后面进行回帖,我们会逐渐进行修订。
|