spacemacs/contrib/lang/ess/README.md

62 lines
2.2 KiB
Markdown
Raw Normal View History

2014-11-11 03:27:06 +00:00
# R (ESS) contribution layer for Spacemacs
2014-12-12 00:55:44 +00:00
![logo](r.jpg)
2014-12-10 05:00:09 +00:00
2014-12-12 01:00:33 +00:00
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
- [R (ESS) contribution layer for Spacemacs](#r-ess-contribution-layer-for-spacemacs)
- [Install](#install)
- [Key Bindings](#key-bindings)
- [Inferior REPL process](#inferior-repl-process)
- [Other R commands](#other-r-commands)
<!-- markdown-toc end -->
2014-11-11 03:27:06 +00:00
## Install
To use this contribution add it to your `~/.spacemacs`
```elisp
2014-12-10 04:50:48 +00:00
(setq-default dotspacemacs-configuration-layers '(ess)
2014-11-11 03:27:06 +00:00
"List of contribution to load."
)
```
## Key Bindings
**Important**:
In order to speed up the boot time of `Spacemacs`, `ESS` must be loaded
manually via the key binding:
<SPC> e s s
### Inferior REPL process
2014-12-12 01:00:33 +00:00
Start an `R` inferior REPL process with <kbd>SPC m i</kbd>.
2014-11-11 03:27:06 +00:00
Send code to inferior process commands:
2014-12-12 01:00:33 +00:00
Key Binding | Description
--------------------|------------------------------------------------------------
<kbd>SPC m b</kbd> | send buffer and keep code buffer focused
<kbd>SPC m B</kbd> | send buffer and switch to REPL in insert mode
<kbd>SPC m d</kbd> | send region or line and step (debug)
<kbd>SPC m D</kbd> | send function or paragraph and step (debug)
<kbd>SPC m l</kbd> | send line and keep code buffer focused
<kbd>SPC m L</kbd> | send line and switch to REPL in insert mode
<kbd>SPC m r</kbd> | send region and keep code buffer focused
<kbd>SPC m R</kbd> | send region and switch to REPL in insert mode
<kbd>SPC m t</kbd> | send thing at point (function) and keep code buffer focused
<kbd>SPC m T</kbd> | send thing at point (function) and switch to REPL in insert mode
<kbd>CTRL+j</kbd> | next item in REPL history
<kbd>CTRL+k</kbd> | previous item in REPL history
2014-11-11 03:27:06 +00:00
### Other R commands
2014-12-12 01:00:33 +00:00
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m p</kbd> | object introspection popup [ess-R-object-popup][ess-R-object-popup]
<kbd>SPC m v p</kbd> | view data under point using [ess-R-data-view][ess-R-data-view]
<kbd>SPC m v t</kbd> | view table using [ess-R-data-view][ess-R-data-view]