R语言:QC()函数中文帮助文档(中英文对照)

loveR

QC(tools)
QC()所属R语言包：tools

                                        QC Checks for R Code and/or Documentation
                                         R代码和/或文件的质量控制检查

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

Functions for performing various quality checks.
执行各种质量检查中的作用。


用法----------Usage----------


checkDocFiles(package, dir, lib.loc = NULL)
checkDocStyle(package, dir, lib.loc = NULL)
checkReplaceFuns(package, dir, lib.loc = NULL)
checkS3methods(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 should contain the subdirectories "R" (for R code) and "man" with R documentation sources (in Rd format).  Only used if package is not given.
一个字符串，指定包的根源目录的路径。这应包含子目录R（R代码）和man（Rd格式）与R文档来源。只用了package如果没有给出。


参数：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----------

checkDocFiles checks, for all Rd files in a package, whether all arguments shown in the usage sections of the Rd file are documented in its arguments section.  It also reports duplicated entries in the arguments section, and "over-documented" arguments which are given in the arguments section but not in the usage.  Note that the match is for the usage section and not a possibly existing synopsis section, as the usage is what gets displayed.
checkDocFiles检查，路包中的所有文件，是否使用部分号文件中显示的所有参数都记录在它的参数部分。它还报告中的参数部分重复的条目，“过记载，在参数部分，但在使用的参数。请注意，比赛使用的部分和没有可能现有的概要部分，使用的是被显示。

checkDocStyle investigates how (S3) methods are shown in the usages of the Rd files in a package.  It reports the methods shown by
checkDocStyle探讨如何包号文件的用法（三）方法。报告所显示的方法


值----------Value----------

The functions return objects of class the same as the respective function names containing the information about problems detected. There are print methods for nicely displaying the information contained in such objects.
该函数将返回各自的功能包含发现的问题有关的信息的名称相同的类的对象。有print很好地显示在这些对象中包含的信息的方法。

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。