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