R parse_Rd 解析 Rd 文件

說明

此函數讀取 R 文檔 (Rd) 文件並對其進行解析，以供其他函數處理。

用法

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

參數

file	文件名或文本模式連接。目前文件名效果最好。
srcfile	NULL 或 "srcfile" 對象。請參閱“詳細信息”部分。
encoding	輸入字符串假定的編碼。
verbose	邏輯指示是否應該打印詳細的解析信息。
fragment	邏輯指示文件是代表完整的 Rd 文件還是片段。
warningCalls	邏輯：解析器警告是否應該包含調用？
macros	從中加載附加宏的文件名或環境，或邏輯值。請參閱下麵的詳細信息。
permissive	邏輯表明無法識別的宏應被視為文本而不發出警告。
x	Rd 類的對象。
deparse	如果是 TRUE ，則嘗試恢複轉義字符，以便結果字符將解析為同一對象。
...	要傳遞給其他方法或從其他方法傳遞的更多參數。

細節

該函數解析‘路' 根據中給出的規範的文件https://developer.r-project.org/parseRd.pdf.

它會為每個解析錯誤生成警告並嘗試繼續解析。為了繼續，通常需要刪除文件的某些部分，因此不應忽略此類警告。

沒有標記編碼的文件默認假定為本機編碼。可以使用 encoding 參數設置備用默認值。文件中的所有文本都會轉換為解析對象中的 UTF-8 編碼。

來自R版本 3.2.0，用戶定義的宏可以在單獨的文件中使用‘⁠\新命令⁠' 或者 '⁠\更新命令⁠’。還可以給出一個環境：它將由loadRdMacros,loadPkgRdMacros，或者通過之前的調用parse_Rd。如果給出邏輯值，則僅使用默認的內置宏；FALSE表明沒有"macros"屬性將隨結果一起返回。

permissive 參數允許解析不完全為 Rd 格式的文本。通常它是 LaTeX 代碼，用在 Rd 片段中，例如在 bibentry 中。對於 permissive = TRUE ，這將以純文本形式傳遞。由於 parse_Rd 不知道 LaTeX 宏中有多少個參數，因此它會根據宏後麵是否存在大括號來猜測；這並非絕對正確。

值

parse_Rd 返回類 "Rd" 的對象。該對象的內部格式可能會發生變化。為類定義的 as.character() 和 print() 方法分別返回字符向量並打印它們。

除非 macros = FALSE ，否則該對象將具有名為 "macros" 的屬性，該屬性是包含 file 中定義的宏的環境，其格式可用於同一會話中進一步的 parse_Rd 調用。如果保存到文件並在不同的會話中重新加載，則不能保證它可以工作。

作者

Duncan Murdoch

參考

https://developer.r-project.org/parseRd.pdf

也可以看看

Rd2HTML 用於使用 parse_Rd() 輸出的轉換器。