R QC R 代碼和/或文檔的 QC 檢查

說明

用於對 R 代碼和文檔(尤其是 R 包)執行各種質量控製 (QC) 檢查的函數。

用法

checkDocFiles   (package, dir, lib.loc = NULL, chkInternal = NULL)
checkDocStyle   (package, dir, lib.loc = NULL)
checkReplaceFuns(package, dir, lib.loc = NULL)
checkS3methods  (package, dir, lib.loc = NULL)
checkRdContents (package, dir, lib.loc = NULL, chkInternal = NULL)

langElts
nonS3methods(package)

參數

package	命名已安裝包的字符串。
dir	指定包根源路徑的字符串(或已安裝在某些情況下)目錄。這應該包含子目錄‘R’(對於 R 代碼)和‘男人' 和R文檔來源(Rd 格式)。僅在以下情況下使用package沒有給出。
lib.loc	目錄名稱的字符向量R Library ，或NULL.默認值為NULL對應於當前已知的所有庫。指定的庫樹用於搜索package.
chkInternal	邏輯指示是否還應檢查標有關鍵字 internal 的 Rd 文件。如果NULL(默認)，則檢查“specially”，忽略缺少的參數文檔。

細節

checkDocFiles 檢查包中的所有 Rd 文件，Rd 文件的使用部分中顯示的所有參數是否都記錄在其參數部分中。它還報告參數部分中的重複條目，以及在參數部分中給出但不在用法中給出的“over-documented”參數。

checkDocStyle研究 (S3) 方法如何在包中的 Rd 文件的用法中顯示。它報告通過全名顯示的方法，而不是使用 Rd⁠\method⁠用於指示 S3 方法的標記。早期版本R還報告了與其泛型一起顯示的方法，這通常會導致泛型及其方法中主要參數的文檔出現問題。和⁠\method⁠現在以保留類信息的方式進行擴展，聯合文檔不再一定是問題。 (相應的信息仍然包含在返回的對象中checkDocStyle.)

checkReplaceFuns 檢查包 R 代碼中的替換函數或 S3/S4 替換方法是否有名為 value 的最終參數。

checkS3methods 檢查包 R 代碼中定義的所有 S3 方法是否具有相應泛型的所有參數，並且泛型的位置參數位於該方法的相同位置。作為例外，公式方法的第一個參數可以稱為 formula，即使這不是泛型使用的名稱。涉及... 時的規則很微妙：請參閱源代碼。被識別為 S3 泛型的函數是那些在其主體中調用 UseMethod 的函數、內部 S3 泛型(請參閱 InternalMethods )和 S3 組泛型(請參閱 Math )。不考慮可能以不同名稱進行的派送。首先在給定的包中查找泛型，然後(如果給定已安裝的包)在包導入中查找，最後在 base 包的命名空間環境中查找。

checkRdContents() 檢查 Rd 內容，例如，使用部分中函數的參數是否有非空說明。

nonS3methods(package) 返回一個 character 向量，其中包含 package 中的函數名稱，其中 ‘look’ 類似於 S3 方法，但又不同。使用 package = NULL 返回所有已知示例。

langElts是 “language elements” 的名稱的字符向量R。這些被實現為 “very primitive” 函數(無參數列表；print()ing為.Primitive("<name>"))。

如果使用已安裝的軟件包，則需要訪問所有的檢查R包的對象將加載包(除非它是base包)，在可能分離已加載的包版本之後。

值

這些函數返回與包含有關檢測到的問題的信息的相應函數名稱相同的類對象。有 print 方法可以很好地顯示此類對象中包含的信息。