checkRd(tools)
checkRd()所属R语言包：tools
Check an Rd Object
检查路对象
译者：生物统计家园网 机器人LoveR
描述----------Description----------
Check an help file or the output of the parse_Rd function.
检查parse_Rd功能的帮助文件或输出。
用法----------Usage----------
checkRd(Rd, defines = .Platform$OS.type, stages = "render",
unknownOK = TRUE, listOK = TRUE, ..., def_enc = FALSE)
参数----------Arguments----------
参数：Rd
a filename or Rd object to use as input.
文件名或Rd对象作为输入使用。
参数：defines
string(s) to use in <PRE>#ifdef</PRE> tests.
字符串（S）在<PRE>的＃ifdef </ pre>测试使用。
参数：stages
at which stage ("build", "install", or "render") should <PRE>\Sexpr</PRE> macros be executed? See the notes below.
在哪个阶段（"build"，"install"或"render"）应<PRE> \ Sexpr </ pre>宏被执行？见下面的说明。
参数：unknownOK
unrecognized macros are treated as errors if FALSE, otherwise warnings.
无法识别的宏如果FALSE，否则警告视为错误。
参数：listOK
unnecessary non-empty braces (e.g., around text, not as an argument) are treated as errors if FALSE, otherwise warnings.
如果FALSE，否则警告的错误被视为不必要的非空括号（例如，文本周围，而不是作为一个参数）。
参数：...
additional parameters to pass to parse_Rd when Rd is a filename. One that is often useful is encoding.
额外的参数传递给parse_Rd时Rd是一个文件名。往往是有益的，是encoding。
参数：def_enc
logical: has the package declared an encoding, so tests for non-ASCII text are suppressed?
逻辑：包声明的编码，因此抑制非ASCII文本的测试？
Details
详情----------Details----------
checkRd performs consistency checks on an Rd file, confirming that required sections are present, etc.
checkRd号文件执行一致性检查，确认所需的部分是目前等
It accepts a filename for an Rd file, and will use parse_Rd to parse it before applying the checks. If so, warnings from parse_Rd are collected, together with those from the internal function prepare_Rd, which does the
它接受一个号文件的文件名，将使用parse_Rd解析申请前检查。如果是这样，parse_Rd收集，与那些从内部功能prepare_Rd在一起，这确实警告
checkRd itself can show
checkRd“本身可以显示
and variations with
和变奏曲
值----------Value----------
This may fail through an R error, but otherwise warnings are collected as returned as an object of class "checkRd", a character vector of messages. This class has a print method which only prints unique messages, and has argument minlevel that can be used to select only more serious messages. (This is set to -1 in R CMD check.)
这可能会失败，通过一个R错误，但作为一个对象类"checkRd"，特征向量的消息返回，否则警告收集。这个类有一个print方法只打印唯一的消息，并具有参数minlevel可以用来选择只有更严重的消息。 （这是设置为-1在R CMD check。）
Possible fatal errors are those from running the parser (e.g. a non-existent file, unclosed quoted string, non-ASCII input without a specified encoding) or from prepare_Rd (multiple
可能致命的错误是从运行分析器（例如，没有一个不存在的文件，未闭合的引号的字符串，非ASCII输入指定的编码），或从prepare_Rd（多
作者（S）----------Author(s)----------
Duncan Murdoch, Brian Ripley
参见----------See Also----------
parse_Rd, Rd2HTML.
parse_Rd，Rd2HTML。
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。
|
发表于 2012-2-16 19:35:40
