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。