r(9)

SYNOPSIS

r - R Language File.
r-doc
r-doc function
r-doc package::packagename
r-doc package::function

FILES

hkr.emf - R Language file hook and r-doc definition
r.eaf - R language abbreviation file
r.etf - R language template file

EXTENSIONS

.r - R file

MAGIC STRINGS

^#![ \t]*/.*env[ \t]+Rscript


MicroEmacs recognizes the magic string on the first line of the file used to locate the executable. The Rscript files may be extension-less and are still recognized.

DESCRIPTION

The R macro file hook provides simple hilighting of R files, inserting abbreviations and browsing the structure of the file using item-list and folding..

File recognition is performed using the standard file extension .r, .R or by the magic string.

Abbreviations


The installation comes with a default abbreviation file for R code editing which can be used by writing short abbreviations like "main" for a default Rscript application outline,"for", "if" or "fun" - for a R function - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Folding and Information Hiding


Generic folding is enabled within the R files. The folds occur about the function keywords located on the left-hand margin at the beginning of the line if the smaller-minus assignment operator is used. The following commands are supported to show and hide the function bodies. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

List Items


Item listing is available and the key constructs of the file may be listed in the item-list.

Short Cuts


The short cut keys used within the buffer are:-

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with stars (*).
A-C-i - Restyle the current region.
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - list items
esc f6 - close list items

Executing, Formatting and Linting R Code


The R file hook supports the file-exec(3), the file-format(3) and the file-lint(3) macros. The R packages which are currently supported are "formatR" and "lintr". They can be installed either using your standard package manager system wide or, for the current user, using the "install.packages" function. Here an example on how to install these packages from within R:

$ R 
> install.packages(c("formatR","lintr")) 

r-doc macro


r-doc provides a mechanism to display an R manual page within MicroEmacs. On invoking r-doc the user is prompted for the name of the manual page to display:-

R help on ? 

The command invokes the R help function, Rscript(1), for the R manual page entered in the message line.

Another R documentation page can be selected in the generated help page by either moving the cursor to the link and pressing return or double clicking on it with the left mouse button. MicroEmacs will then attempt to load and display the selected R manual page.

NOTES

The hilighting or the item-list matches are typically extended using a file myr.emf

BUGS

Functions with using the equal operator for assignments are not shown in the function outline, this should be seen as a feature which allow you to write hidden internal functions within other functions.

SEE ALSO

abbrev-list(3), c(9), collapse-all(3), collapse-current(3), compile(3), expand-abbrev-handle(3), file-exec(3), file-format(3), file-lint(3), item-list(3), restyle-buffer(3), restyle-region(3), py(9), sh(9).

Supported File Types

(c) Copyright JASSPA 2025
Last Modified: 2025/08/28
Generated On: 2025/09/29