Home

vscode-R is the R Extension for Visual Studio Code. The extension is mainly focused on providing user interactivity between VSCode and R sessions. To make VSCode more powerful in R scripting, it is highly recommended to also install the R language server (languageserver and vscode-r-lsp).

Visit the links on the right for more information.

This project won't be successful without contributions, especially the current and past key collaborators:

• Kun Ren (@renkun-ken)
• Andrew Craig (@andycraig)
• Thomas Brittain (@Ladvien)
• Miles McBain (@MilesMcBain)
• Manuel Hentschel (@ManuelHentschel)
• Elian H. Thiele-Evans (@ElianHugh)

Features

• Extended syntax highlighting for R, R Markdown, and R Documentation.

• Snippets for R and R Markdown.

• Interacting with R terminals: Sending code to terminals, running multiple terminals, working with remote servers.

• Keyboard shortcuts: Built-in and customizable keyboard shortcuts.

• Workspace viewer: Environment pane to show global variables in the attached R session.

• Help pages viewer: Viewing R help pages and searching help topics.

• Package management: Installing and removing R packages.

• Session symbol hover and completion.

• Data viewer: Viewing data.frame or matrix in a grid or a list structure in a treeview.

• Plot viewer: PNG file viewer and SVG plot viewer based on httpgd.

• Webpage viewer: Viewing htmlwidgets such as interactive graphics and visual profiling results.

• Browser viewer: Viewing interactive shiny apps.

• R Markdown support: R Markdown chunk highlighting, chunk navigation, and execute commands.

• RStudio add-in support: Run supported RStudio add-ins in VS Code with a live R session.

• Full support of Remote Development via SSH, Containers and WSL.

• Live share collaboration: Shared workspace, terminal, and viewer in R pair programming.

Extension Settings

This extension contributes the following settings:

• r.rterm.windows: set to R.exe path for Windows

• r.rterm.mac: set to R term's path for Mac OS X

• r.rterm.linux: set to R term's path for Linux

• r.rpath.lsp: set to R.exe path for Language Server Protocol

• r.rterm.option: R command line options (i.e: --vanilla)

• r.source.encoding: An optional encoding to pass to R when executing the file

• r.source.focus: Keeping focus when running (editor or terminal)

• r.alwaysUseActiveTerminal: Use active terminal for all commands, rather than creating a new R terminal

• r.bracketedPaste: For consoles supporting bracketed paste mode (such as Radian)

• r.sessionWatcher: Enable R session watcher (experimental)

• r.rtermSendDelay: Delay in milliseconds before sending each line to rterm (only applies if r.bracketedPaste is false)

• r.rmarkdown.enableCodeLens: Enable RMarkdown CodeLens, which are inline commands/buttons e.g. 'Run Chunk | Run Above' shown on the first line of each code chunk.

  Details

  • Click the buttons to run commands.
  • Hover on the buttons to show tooltips.
  • CodeLens commands are customizable via settings UI (Rmarkdown: Code Lens commands) or settings.json r.rmarkdown.codeLensCommands

• r.rmarkdown.codeLensCommands: Customize RMarkdown CodeLens, which are inline commands/buttons e.g. 'Run Chunk | Run Above' shown on the first line of each code chunk.

  Details
  Available commands:

  • r.selectCurrentChunk

  • r.runCurrentChunk

  • r.runAboveChunks

  • r.runCurrentAndBelowChunks

  • r.runBelowChunks

  • r.runAllChunks

  • r.runPreviousChunk

  • r.runNextChunk

  • r.goToPreviousChunk

  • r.goToNextChunk
    

    Customize both the commands AND its orders (that is, CodeLens respect user-specified orders). Default commands:

  • r.runCurrentChunk

  • r.runAboveChunks

  • <Add item...>

• r.rmarkdown.chunkBackgroundColor: RMarkdown chunk background color in RGBA or RGB value.

  Details

  Defaults to rgba(128, 128, 128, 0.1). Leave it empty to disable it (use default editor background color). Reload VS Code after changing settings. Learn how to set colors: https://www.w3schools.com/css/css_colors_rgb.asp
  
  

  Examples for syntax rgba(<red>, <green>, <blue>, <alpha>):

  • rgba(128, 128, 128, 0.1)
  • rgba(128, 128, 128, 0.3)
  • rgba(255, 165, 0, 0.1)