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 方法可以很好地显示此类对象中包含的信息。