User manual

Chapter 10: Developing with ESS 51

C-h m Describe the features of Rd mode.

LFD

RET Reindent the current line, insert a newline and indent the new line (reindent-

then-newline-and-indent). An abbrev before point is expanded if abbrev-

mode is non-nil.

TAB Indent current line based on its contents and on previous lines. (indent-

according-to-mode).

C-c C-e Insert a “skeleton” with Rd markup for at least all mandatory entries in Rd ﬁles

(Rd-mode-insert-skeleton). Note that many users might prefer to use the R

function prompt on an existing R object to generate a non-empty Rd “shell”

documenting the object (which already has all information ﬁlled in which can

be obtained from the object).

C-c C-f Insert “font” speciﬁers for some of the Rd markup commands markup available

for emphasizing or quoting text, including markup for URLs and email addresses

(Rd-font). C-c C-f is only a preﬁx; see e.g. C-c C-f TAB for the available

bindings. Note that currently, not all of the Rd text markup as described in

section “Marking text” of “Writing R Extensions” can be accessed via C-c C-f.

C-c C-j Insert a suitably indented ‘\item{’ on the next line (Rd-mode-insert-item).

C-c C-p Preview a plain text version (“help ﬁle”, see Chapter 8 [Help], page 44) gener-

ated from the Rd ﬁle (Rd-preview-help).

In addition, when editing Rd ﬁles one can interact with a running R process in a similar

way as when editing R language ﬁles. E.g., C-c C-v provides access to on-line help, and C-c

C-n sends the current line to the R process for evaluation. This interaction is particularly

useful when editing the examples in the Rd ﬁle. See C-h m for all available commands.

Rd mode also provides access to abbreviations for most of the Rd markup commands.

Type M-x list-abbrevs with Abbrev mode turned on to list all available abbrevs. Note

that all Rd abbrevs start with a grave accent.

Rd mode can be customized via the following variables.

[User Option]Rd-mode-hook

Hook to be run when Rd mode is entered.

[User Option]Rd-indent-level

The indentation of Rd code with respect to containing blocks. Default is 2.

[User Option]Rd-to-help-command

The shell command used for converting Rd source to help text. Default is ‘R CMD

Rd2txt’.

To automatically turn on the abbrev and font-lock features of Rd mode, add the following

lines to one of your Emacs startup ﬁles:

(add-hook ’Rd-mode-hook

(lambda ()

(abbrev-mode 1)

(font-lock-mode 1)))