R Rd2HTML 路轉換器

說明

這些函數獲取 parse_Rd() (一個 Rd 對象)的輸出，並從中生成幫助頁麵。由於它們主要供內部使用，因此它們的接口可能會發生變化。

用法

Rd2HTML(Rd, out = "", package = "", defines = .Platform$OS.type,
        Links = NULL, Links2 = NULL,
        stages = "render", outputEncoding = "UTF-8",
        dynamic = FALSE, no_links = FALSE, fragment = FALSE,
        stylesheet = if (dynamic) "/doc/html/R.css" else "R.css",
        texmath = getOption("help.htmlmath"),
        concordance = FALSE,
        standalone = TRUE,
        Rhtml = FALSE,
        ...)

Rd2txt(Rd, out = "", package = "", defines = .Platform$OS.type,
       stages = "render", outputEncoding = "",
       fragment = FALSE, options, ...)

Rd2latex(Rd, out = "", defines = .Platform$OS.type,
         stages = "render", outputEncoding = "UTF-8",
         fragment = FALSE, ..., writeEncoding = TRUE,
         concordance = FALSE)

Rd2ex(Rd, out = "", defines = .Platform$OS.type,
      stages = "render", outputEncoding = "UTF-8",
      commentDontrun = TRUE, commentDonttest = FALSE, ...)

參數

Rd	用作輸入的文件名或 Rd 對象。
out	要寫入輸出的文件名或連接對象。默認 out = "" 相當於 out = stdout() 。
package	要在輸出中列出的包。
defines	⁠#ifdef⁠ 測試中使用的字符串。
stages	⁠\Sexpr⁠ 宏應該在哪個階段( "build" 、 "install" 或 "render" )執行？請參閱下麵的注釋。
outputEncoding	請參閱下麵的“編碼”部分。
dynamic	邏輯：通過動態幫助係統設置render-time解析的鏈接。
no_links	邏輯：禁止指向其他幫助主題的超鏈接。由 R CMD Rdconv 使用。
fragment	邏輯：應該接受 Rd 文件的片段嗎？請參閱下麵的注釋。
stylesheet	字符：要在 HTML 輸出頁麵的標頭中使用的樣式表的 URL。
texmath	字符：控製 ⁠\eqn⁠ 和 ⁠\deqn⁠ 命令中的數學在 HTML 輸出中的排版方式。有用的值是"katex"(默認)和"mathjax"，分別使用KaTeX 或MathJax，否則使用基本替換。在某些情況下可能會被忽略，例如，如果幫助頁麵已使用 mathjaxr 包中的宏。
concordance	一致性數據是否應嵌入到輸出文件中並附加到返回值。
standalone	邏輯：輸出是否是一個獨立的 HTML 文件。如果 FALSE ，則省略頁眉和頁腳，以便輸出可以與其他片段組合。
Rhtml	邏輯：輸出是否是可以使用 knitr 處理的 Rhtml 文件。如果是 TRUE ，則示例部分包含在 rcode 塊內。
Links , Links2	NULL 或鏈接的命名(按主題)字符向量，由 findHTMLlinks 返回。
options	要傳遞給 Rd2txt_options 的可選命名選項列表。
...	當 Rd 是文件名時傳遞給 parse_Rd 的附加參數。
writeEncoding	對於非 ASCII 編碼，是否應該在文件中寫入 ⁠\inputencoding⁠ 行？
commentDontrun	⁠\dontrun⁠ 部分應該被注釋掉嗎？
commentDonttest	⁠\donttest⁠ 部分應該被注釋掉嗎？

細節

這些函數轉換幫助文檔：Rd2HTML生成 HTML，Rd2txt產生純文本，Rd2latex生產乳膠。Rd2ex以使用的格式提取示例example和R公用事業。

每個函數都接受 Rd 文件的文件名，並在應用轉換或檢查之前使用 parse_Rd 對其進行解析。

參數 Link 和 Link2 之間的區別在於，依次在它們中查找鏈接，因此 lazy-evaluation 可用於僅在需要時對鏈接進行 second-level 搜索。

前R3.6.0，默認為Rd2latex曾是outputEncoding = "ASCII"，包括使用第二個選項⁠\enc⁠標記，因為 LaTeX 版本長期以來沒有提供足夠的 UTF-8 字形覆蓋。

Rd2txt將格式化文本段落的寬度由width，具有適當的邊距。默認值是接近版本中的渲染R< 2.10.0。

如果選項 "useFancyQuotes" 為 true(通常是默認值，請參閱 sQuote )且當前編碼為 UTF-8，Rd2txt 將使用定向引號(請參閱 sQuote )。

Rd2txt 格式化的各個方麵均由 options 參數控製，由 Rd2txt_options 函數記錄。使用 options 所做的更改是臨時的，使用 Rd2txt_options 所做的更改是持久的。

當 fragment = TRUE 時，將渲染 Rd 文件，而不使用 ⁠#ifdef⁠ 或 ⁠#ifndef⁠ 處理 ⁠\Sexpr⁠ 元素或條件定義。通常，片段表示節內的文本，但如果片段的第一個元素是節宏，則整個片段將呈現為一係列節，而不進行通常的排序。

值

執行這些函數主要是為了減少編寫轉換後的幫助頁麵的副作用。它們的值是輸出文件的名稱(不可見)。為了Rd2latex，輸出名稱被賦予一個屬性"latexEncoding"以適合與 LaTeX 一起使用的形式給出文件的編碼輸入法' 包。為了Rd2HTML和standalone = FALSE，一個屬性"info"提供補充信息，例如內容name和title字段。目前該函數尚處於實驗階段，詳細信息可能會發生變化。

對於 Rd2HTML 和 Rd2latex 以及 concordance = TRUE ，添加 "concordance" 屬性，其中包含 Rconcordance 對象。

編碼

Rd 文件通常旨在在各種係統上呈現，因此必須小心非 ASCII 字符的編碼。一般來說，任何此類編碼都應使用‘⁠編碼⁠”部分，以便有正確渲染的希望。

對於輸出，將使用 outputEncoding 參數：outputEncoding = "" 將為當前係統選擇本機編碼。

如果文本無法轉換為outputEncoding，將使用字節替換(請參見iconv)：Rd2latex 和Rd2ex 給出警告。

注意

⁠\Sexpr⁠宏包括R將在三個時間之一執行的代碼：建造時間(當包的源代碼構建到 tarball 中時)，安裝時間(當包安裝或構建到二進製包中時)，以及使成為時間(當手冊頁轉換為可讀格式時)。

例如，這個手冊頁是：

1. 建於 2023 年 8 月 10 日 01:47:25，

2. 安裝於 2023 年 8 月 10 日 01:47:25，並且

3. 於 2023 年 8 月 10 日 01:47:32 呈現。

例子

## Not run: 
## Simulate install and rendering of this page in HTML and text format:

Rd <- file.path("src/library/tools/man/Rd2HTML.Rd")

outfile <- tempfile(fileext = ".html")
browseURL(Rd2HTML(Rd, outfile, package = "tools",
          stages = c("install", "render")))

outfile <- tempfile(fileext = ".txt")
file.show(Rd2txt(Rd, outfile, package = "tools",
          stages = c("install", "render")))

checkRd(Rd) # A stricter test than Rd2HTML uses

## End(Not run)

作者

Duncan Murdoch, Brian Ripley

參考

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

也可以看看

parse_Rd、checkRd、findHTMLlinks、Rd2txt_options、matchConcordance。