R undoc 查找未记录的对象

说明

查找包中未记录的对象，即它们对用户可见(或包提供的数据对象或 S4 类)，但不存在文档条目。

用法

undoc(package, dir, lib.loc = NULL)

参数

package	命名已安装包的字符串。
dir	指定包根源目录路径的字符串。这必须包含子目录‘男人' 和R文档来源(Rd 格式)，以及至少其中一个‘R' 或者 '数据' 子目录R分别是代码或数据对象。
lib.loc	目录名称的字符向量R Library ，或NULL.默认值为NULL对应于当前已知的所有库。指定的库树用于搜索package.

细节

此函数对于软件包维护者来说非常有用。原则，全部user-levelR应该记录对象。

base 包很特殊，因为它包含原语，并且这些原语在代码级别没有可用的定义。我们在 base 包中的环境 .ArgsEnv 和 .GenericArgsEnv 中提供了等效的闭包，这些闭包用于各种目的：undoc("base") 检查所有非语言构造的原语是否在这些环境中原型化，而没有其他环境原型化。

值

"undoc" 类的对象，它是一个字符向量列表，其中包含根据文档类型拆分的未记录对象的名称。

有一个 print 方法可以很好地显示此类对象中包含的信息。

例子

undoc("tools")                  # Undocumented objects in 'tools'

也可以看看

codoc , QC