User manual

Chapter 10: Developing with ESS 50
w . Watch window . ‘ess-watch’
(C- prefixed equivalents are also defined)
* Navigation to errors (general emacs functionality):
C-x ‘, M-g n . ‘next-error’
M-g p . ‘previous-error’
* Misc:
? . Show this help . ‘ess-tracebug-show-help’
To configure how electric watch window splits the display see ess-watch-width-
threshold and ess-watch-height-threshold variables.
A more detailed ess-tracebug documentation with screenshots is available at
http://code.google.com/p/ess-tracebug/.
A short tutorial is at http://code.google.com/p/ess-tracebug/wiki/GettingStarted.
Note: Currently, ess-tracebug does not detect some of R’s debug related messages in
non-English locales. To set your R messages to English add the following line to your
.Rprofile init file:
Sys.setlocale("LC_MESSAGES", "C")
10.2 Editing documentation
ESS provides two ways of writing documentation for R objects. Either using the standard
R documentation system or using in-source documentation written as structured comment
fields for use with the Roxygen package.
10.2.1 Editing R documentation (Rd) files
R objects are documented in files written in the R documentation (“Rd”), a simple markup
language closely resembling (La)T
E
X, which can be processed into a variety of formats,
including LaT
E
X, HTML, and plain text. Rd format is described in section “Rd format” of
the “Writing R Extensions” manual in the R distribution. ESS has several features that
facilitate editing Rd files.
Visiting an Rd file as characterized by its extension ‘Rd’ will activate Rd Mode, which
provides several facilities for making editing R documentation files more convenient, by
helping with indentation, insertions, even doing some of the typing for you (with Abbrev
Mode), and by showing Rd keywords, strings, etc. in different faces (with Font Lock Mode).
Note that R also accepts Rd files with extension ‘rd’; to activate ESS[Rd] support for
this extension, you may need to add
(add-to-list ’auto-mode-alist ’("\\.rd\\’" . Rd-mode))
to one of your Emacs startup files.
In Rd mode, the following special Emacs commands can be used in addition to the
standard Emacs commands.