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