R Rd2txt_options 设置文本帮助的格式选项

说明

此函数设置用于显示文本帮助的各种选项。

用法

Rd2txt_options(...)

参数

...	包含命名选项或作为单独命名参数传递的选项的列表。有关当前定义的内容，请参阅下文。

细节

此函数为 Rd2txt 函数持久设置各种格式选项，该函数用于显示文本格式帮助。当前定义的选项有：

宽度

(默认80)：输出页面的宽度。

最小缩进量

(默认 10)：列表中使用的最小缩进。

额外缩进

(默认值 4)：在每一层嵌套列表中使用的额外缩进。

节缩进

(默认值 5)：节的缩进级别。

额外部分

(默认值 2)：每个嵌套节级别的额外缩进。

项目项目符号

(默认 "* " ，星号在 UTF-8 和大多数 Windows 语言环境中替换为 Unicode 项目符号)：在逐项列表中用作项目符号的符号。

枚举格式

：格式化枚举列表中的项目编号的函数。

显示网址

(默认 FALSE )：展开 ⁠\href⁠ 标签时是否显示 URL。

code_quote

(默认 TRUE )：是否渲染 ⁠\code⁠ 以及类似的单引号。

underline_titles

(默认 TRUE )：是否使用下划线渲染节标题(通过退格)。

值

如果不带参数调用，则返回列表中的所有选项设置。否则，它会更改指定的设置并以不可见的方式返回其先前的值。

例子

# The itemBullet is locale-specific
saveOpts <- Rd2txt_options()
saveOpts
Rd2txt_options(minIndent = 4)
Rd2txt_options()
Rd2txt_options(saveOpts)
Rd2txt_options()

作者

Duncan Murdoch

也可以看看

Rd2txt