R matchConcordance 源行和目标行之间的一致性

说明

Rd 解析器将位置记录在‘.Rd' 从中读取文件组件的文件。输出发生器Rd2HTML和Rd2latex可以在源行和输出行之间将有关这些位置的信息输出为“concordances”。

matchConcordance 从输出位置转换为源位置。 as.character 的 "Rconcordance" 方法生成要嵌入到输出文件中的字符串，而 as.Rconcordance 的默认方法将这些字符串转换回可由 matchConcordance 解释的对象。

用法

matchConcordance(linenum, concordance)
## S3 method for class 'Rconcordance'
as.character(x, targetfile = "", ...)
as.Rconcordance(x, ...)
followConcordance(concordance, prevConcordance)

参数

linenum	正在查询的一个或多个行号。
concordance	包含行的文件的索引数据：类 "Rconcordance" 的对象。
prevConcordance	从当前文件检索的索引对象。
targetfile	输出文件名。
x	要转换的对象：对于 as.character ，是 "Rconcordance" 对象；对于 as.concordance ，包含 as.character 输出的字符向量，通常在注释中。
...	进一步的参数传递给其他方法。

细节

Rd 文件转换中的目标行和源行之间的对应关系不是一一对应的。通常，单个源线可以导致多条输出线的生成，并且有时多个源线会触发同一输出线上的输出。

matchConcordance 从目标行转换为源行。这可以用来帮助理解特定的输出线如何依赖于源，例如当在输出文件中发现错误时。当多行贡献输出时，将返回最后一行。

as.character 的 "Rconcordance" 方法将索引对象转换为适合在输出文件中嵌入(例如在注释中)的字符串。

as.Rconcordance 的默认方法搜索与 as.character.Rconcordance 输出模式匹配的字符串，然后将这些行转换回单个索引。

当文件多次转换时使用 followConcordance。第一个转换在文件中记录一个索引，读取为 prevConcordance 。 followConcordance 将其与当前的 concordance 链接起来，将最终结果与原始源相关联。

有 3 种用于保存索引的对象。

类 "activeConcordance" 的对象是 tools 的内部对象；它们由 Rd2HTML 和 Rd2latex 在构建输出文件和保存源文件链接时使用。

"Rconcordance" 类的对象对用户可见。它们是具有以下三个字段的列表对象：

offset

与此索引相对应的第一个输出之前的输出行数。

srcLine

对于每行输出后的偏移量，对应输入文件的行号。输出的行数可能多于 srcLine 的长度，在这种情况下，无法推断出这些行的来源。

srcFile

长度为 1 或与 srcLine 相同长度的文件名向量，为每个输出行提供源文件。

索引字符串由 as.character 的 "Rconcordance" 方法生成；它们只是对索引数据进行编码的字符向量。 as.concordance 泛型函数的默认方法将它们转换为 "Rconcordance" 对象。

值

matchConcordance 返回一个字符数组，其中每个输入 linenum 条目一行和两列 "srcFile" 和 "srcLine" 。

对于 as.character 的 "Rconcordance" 方法，使用字符向量(例如在 Sweave 中)将索引嵌入到文件中。

对于 as.concordance 、"Rconcordance" 对象或 NULL(如果未找到索引字符串)。

作者

Duncan Murdoch

也可以看看

Rd2HTML , Rd2latex