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

loveR

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

                                        Generate Index from Rd Files
                                         生成指数从号文件

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

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

Print a 2-column index table with names and titles from given R documentation files to a given output file or connection.  The titles are nicely formatted between two column positions (typically 25 and 72, respectively).
打印2列索引表，从给定的R文档文件到一个给定的输出文件或连接的姓名和头衔。标题格式化很好的两列的位置（一般为25和72，分别）。


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


Rdindex(RdFiles, outFile = "", type = NULL,
        width = 0.9 * getOption("width"), indent = NULL)



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

参数：RdFiles
a character vector specifying the Rd files to be used for creating the index, either by giving the paths to the files, or the path to a single directory with the sources of a package.
文件用于创建索引，或者给予的路径的文件，或与包的来源单一目录的路径，指定一个字符向量的路。


参数：outFile
a connection, or a character string naming the output file to print to.  "" (the default) indicates output to the console.
一个连接，或一个字符串，命名输出文件打印到。 ""（默认）表示输出到控制台。


参数：type
a character string giving the documentation type of the Rd files to be included in the index, or NULL (the default). The type of an Rd file is typically specified via the  <PRE>\docType</PRE> tag; if type is "data", Rd files whose only keyword is datasets are included as well.
字符串的路的文档类型的文件被包含在索引中，或NULL（默认）。号文件的类型通常是指定通过<PRE> \ DOCTYPE </ pre>标签;如果type是"data"路文件，其唯一的关键字是datasets都包括在内。


参数：width
a positive integer giving the target column for wrapping lines in the output.
一个正整数，使包装在输出线的目标列。


参数：indent
a positive integer specifying the indentation of the second column.  Must not be greater than width/2, and defaults to width/3.
一个正整数，指定缩进的第二列。绝不能比width/2，默认为width/3。


Details

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

If a name is not a valid alias, the first alias (or the empty string if there is none) is used instead.
如果一个名字是不是一个有效的别名，第一个别名（或空字符串，如果没有，）来代替。

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


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