Rd2txt_options | R Documentation |
This function sets various options for displaying text help.
Rd2txt_options(...)
... |
A list containing named options, or options passed as individual named arguments. See below for currently defined ones. |
This function persistently sets various formatting options for the
Rd2txt
function which is used in displaying text format
help. Currently defined options are:
(default 80): The width of the output page.
(default 10): The minimum indent to use in a list.
(default 4): The extra indent to use in each level of nested lists.
(default 5): The indent level for a section.
(default 2): The extra indentation for each nested section level.
(default "* "
, with the asterisk replaced by a
Unicode bullet in UTF-8 and most Windows locales):
The symbol to use as a bullet in itemized lists.
: A function to format item numbers in enumerated lists.
(default FALSE
): Whether to show URLs when
expanding \href
tags.
(default TRUE
): Whether to render
\code
and similar with single quotes.
(default TRUE
): Whether to render
section titles with underlines (via backspacing).
If called with no arguments, returns all option settings in a list. Otherwise, it changes the named settings and invisibly returns their previous values.
Duncan Murdoch
Rd2txt
# The itemBullet is locale-specific saveOpts <- Rd2txt_options() saveOpts Rd2txt_options(minIndent = 4) Rd2txt_options() Rd2txt_options(saveOpts) Rd2txt_options()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.