Skip to content

Home

Jump to bottom
James Eapen edited this page Aug 27, 2020 · 29 revisions

Welcome to the Nvim-R wiki!

Authors: - Jakson A. Aquino [email protected] - Jose Claudio Faria [email protected]

Version: 0.9.14.1 For Neovim >= 0.3.4 and Vim >= 8.1

Overview

This plugin improves the support for editing R code with both Vim and Neovim, integrating them with R. Stable versions of this plugin are available available at https://github.com/jalvesaq/Nvim-R/releases

Feedback is welcomed. Please submit bug reports to the developers. Do not like a feature? Tell us and we may add an option to disable it. If you have any comments or questions, please post them at https://groups.google.com/forum/#!forum/vim-r-plugin

The plugin should emit useful warnings if you do things it was not programmed to deal with. Cryptic error message are bugs... Please report them at https://github.com/jalvesaq/Nvim-R/issues

Patches and git pull requests are welcome. If you want a feature that only few people might be interested in, you can write a script to be sourced by Nvim-R (see |R_source|).

Main features

  • Syntax highlighting for R code, including:

    • Special characters in strings.
    • Functions of loaded packages.
    • Special highlighting for R output (.Rout files).
    • Spell check only strings and comments.
    • Fold code when foldmethod=syntax.

  • Integrated communication with R:

    • Start/Close R.
    • Send lines, selection, paragraphs, functions, blocks, entire file.
    • Send commands with the object under cursor as argument: help, args, plot, print, str, summary, example, names.
    • Send to R the Sweave, knit and pdflatex commands.

  • Omni completion for R objects (.GlobalEnv and loaded packages).

  • Omni completion of function arguments.

  • Omni completion of knitr chunk options.

  • Omni completion of bibliographic entries (Rmd and Rnoweb).

  • Omni completion of python code in knitr chunks if the jedi-vim plugin is installed

  • Limited support for debugging R functions.

  • Ability to see R's documentation in an editor buffer:

    • Automatic calculation of the best layout of the R documentation buffer (split the window either horizontally or vertically according to the available room).
    • Automatic formatting of the text to fit the panel width.
    • Send code and commands to R (useful to run examples).
    • Jump to another R documentation.
    • Syntax highlighting of R documentation.

  • Object Browser (.GlobalEnv and loaded packages):

    • Send commands with the object under cursor as argument.
    • Call R's help() with the object under cursor as argument.
    • Syntax highlighting of the Object Browser.

  • SyncTeX support.

  • Most of the plugin's behavior is customizable.

Clone this wiki locally