R.nvim

![GitHub Release](https://img.shields.io/github/v/release/R-nvim/R.nvim)
![Selene linter check](https://github.com/R-Nvim/R.nvim/actions/workflows/selene.yml/badge.svg)
[![CI](https://github.com/R-nvim/R.nvim/actions/workflows/ci.yml/badge.svg)](https://github.com/R-nvim/R.nvim/actions/workflows/ci.yml)

# R.nvim

> [!Note]
> Vim-R users should read the release notes of [version 1.0.0](https://github.com/R-nvim/R.nvim/releases/tag/v1.0.0).

R.nvim adds R support to Neovim, including:

- Communication with R via Neovim's built-in terminal or tmux

- A built-in object explorer and autocompletions built from your R environment

- Keyboard shortcuts for common inserts like `<-` and `|>`

- Quarto/R Markdown/Rtypst support

- ...And much more!

<p align="center">
    <img style="width: 800px" src="screenshot.png">
</p>

The `R.nvim` directory has four different things:

  - A R package (subdirectory `nvimcom`).

  - The C code of an language server for R (subdirectory `rnvimserver`).

  - A tree-sitter parser for `.Rout` files (Git submodule `tree-sitter-rout`
    in the subdirectory `resources`).

  - A Lua plugin for Neovim (most of everything else).

R.nvim automatically:

 - builds and install the R package `nvimcom`;
 - compiles the `rnvimserver` binary in the `rnvimserver` directory;
 - generates the `rout` parser and installs it in the `parser` subdirectory.

## Installation

The `R.nvim` repository must be cloned with its submodule `tree-sitter-rout`.
If your plugin manager does not clone the submodules, you can clone the
repository manually with this command:

```sh
git clone --recurse-submodules https://github.com/R-nvim/R.nvim
```

Please, see the list of dependencies at section 3.1 of
[doc/R.nvim.txt](https://github.com/R-nvim/R.nvim/blob/main/doc/R.nvim.txt).

Here's a (very) minimal configuration using
[lazy.nvim](https://github.com/folke/lazy.nvim) (not including `R.nvim`
dependencies):

```lua
{
    "R-nvim/R.nvim",
     -- Only required if you also set defaults.lazy = true
    lazy = false
},
```

A longer example adding some custom behaviour:

```lua
{
    "R-nvim/R.nvim",
     -- Only required if you also set defaults.lazy = true
    lazy = false,
    -- R.nvim is still young and we may make some breaking changes from time
    -- to time (but also bug fixes all the time). If configuration stability
    -- is a high priority for you, pin to the latest minor version, but unpin
    -- it and try the latest version before reporting an issue:
    -- version = "~0.1.0"
    config = function()
        -- Create a table with the options to be passed to setup()
        ---@type RConfigUserOpts
        local opts = {
            hook = {
                on_filetype = function()
                    vim.api.nvim_buf_set_keymap(0, "n", "<Enter>", "<Plug>RDSendLine", {})
                    vim.api.nvim_buf_set_keymap(0, "v", "<Enter>", "<Plug>RSendSelection", {})
                end
            },
            R_args = {"--quiet", "--no-save"},