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

loveR

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

                                         Parse an Rd file
                                         解析号文件

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

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

This function reads an R documentation (Rd) file and parses it, for processing by other functions.
该函数读取一个R文件（路）文件和分析处理等功能，。


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


parse_Rd(file, srcfile = NULL, encoding = "unknown",
         verbose = FALSE, fragment = FALSE, warningCalls = TRUE)
## S3 method for class 'Rd'
print(x, deparse = FALSE, ...)
## S3 method for class 'Rd'
as.character(x, deparse = FALSE, ...)



参数----------Arguments----------

参数：file
A filename or text-mode connection.  At present filenames work best.
文件名或文本模式连接。目前最有效的文件名。


参数：srcfile
NULL, or a "srcfile" object.  See the "Details" section.
NULL或"srcfile"对象。看到“详细资料”一节。


参数：encoding
Encoding to be assumed for input strings.
假设输入字符串编码方式。


参数：verbose
Logical indicating whether detailed parsing information should be printed.  
逻辑说明是否应印有详细的解析信息。


参数：fragment
Logical indicating whether file represents a complete Rd file, or a fragment.
逻辑表明文件是否代表一个完整的路文件，或一个片段。


参数：warningCalls
Logical: should parser warnings include the call?
逻辑：解析器警告应包括电话吗？


参数：x
An object of class Rd.
一个对象类路。


参数：deparse
If TRUE, attempt to reinstate the escape characters so that the resulting characters will parse to the same object.
如果TRUE，企图恢复的转义字符使字符将解析到同一个对象。


参数：...
Further arguments to be passed to or from other methods.
进一步的参数被传递或其他方法。


Details

详情----------Details----------

This function parses "Rd" files according to the specification given in http://developer.r-project.org/parseRd.pdf.
此功能解析Rd根据，在http://developer.r-project.org/parseRd.pdf规范的文件。

It generates a warning for each parse error and attempts to continue parsing.  In order to continue, it is generally necessary to drop some parts of the file, so such warnings should not be ignored.
它会产生一个警告每一个语法错误，并尝试继续解析。为了继续，它一般是要删除文件的某些部分，因此这样的警告不容忽视。


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

parse_Rd returns an object of class "Rd".  The internal format of this object is subject to change.  The as.character() and print() methods defined for the class return character vectors and print them, respectively.
parse_Rd类"Rd"返回一个对象。如有变更，这个对象的内部格式。 as.character()和print()类回报的特征向量，并打印出来，分别定义的方法。

Files without a marked encoding are by default assumed to be in the native encoding.  An alternate default can be set using the encoding argument.  All text in files is translated to the UTF-8 encoding in the parsed object.
没有显着的编码的文件都被认为默认为本地编码。使用encoding参数，可以设置一个备用的默认。所有文件中的文本转换为UTF-8在解析对象的编码。


作者（S）----------Author(s)----------


Duncan Murdoch



参考文献----------References----------

<h3>See Also</h3>   <code>Rd2HTML</code> for the converters that use the output of <code>parse_Rd()</code>.
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


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