https://github.com/tomtom/workbook_vim

Interactively work with interpreteted languages (R etc.)
https://github.com/tomtom/workbook_vim

r repl vim vim-plugin workbook worksheet

Last synced: about 1 month ago
JSON representation

Interactively work with interpreteted languages (R etc.)

• Host: GitHub
• URL: https://github.com/tomtom/workbook_vim
• Owner: tomtom
• License: gpl-3.0
• Created: 2017-02-14T10:48:49.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-17T18:29:10.000Z (over 7 years ago)
• Last Synced: 2024-08-13T07:18:23.464Z (4 months ago)
• Topics: r, repl, vim, vim-plugin, workbook, worksheet
• Language: Vim script
• Homepage: http://www.vim.org/scripts/script.php?script_id=5527
• Size: 2.38 MB
• Stars: 6
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.TXT
  • License: LICENSE.TXT

Awesome Lists containing this project

• jimsghstars - tomtom/workbook_vim - Interactively work with interpreteted languages (R etc.) (Vim Script)

README

        
The long-term goal of this plugin is to provide notebook-like interaction with 

interpreted languages similar to Mathematica or Jupyter (within the limits 

of a text editor like vim).

# Features

- Run an interpreter as an inferior process.

- Send code to this process (asynchronously without blocking vim).

- Insert (or dynamically update) the results into the source code (as 

  commented out block below the respective source code). See also 

  `g:workbook#insert_results_in_buffer`.

- Transcribe the interaction with the interpreter.

- Provide code completion (see 'omnifunc') for some filetypes.

# How to use this plugin

- Open a file with a supported filetype (see below or 

  `workbook#GetSupportedFiletypes()`).

- Type `:Workbook` or add the filetype to `g:workbook_autosetup_filetypes` to 

  automatically enable the workbook mode for the specified filetypes.

- Press \ to evaluate the current paragraph.

- Press \w\ for help on other commands and maps -- see also 

  `workbook#SetupBuffer()`.

# The following filetypes are supported well

- R (supports code completion)

- Rmd (same as R)

Experimental/basic support is provided for:

- fsharp

- javascript

- python

- ruby

- scala

- sh (default: bash)

- vim

Currenty, the main use case is to interact with R. Other than other 

well-known R-related vim plugins, the workbook plugin has no non-vim 

dependencies and works at least on Linux and Windows with no problems.

# Demo

![demo video](https://dl.dropboxusercontent.com/s/xj3nvbxnu6omocg/workbook_vim.gif?dl=0)]

-----------------------------------------------------------------------

# Install

Either use the zip archive:

- Download the zip archive

- Extract it to ~/.vim/pack/tml/start/workbook

or install from github:

- Start a terminal

- Change the working directory to ~/.vim/pack/tml/start/

- Type: git clone https://github.com/tomtom/workbook_vim

NOTE: On Windows, ~/.vim might be ~/vimfiles. Please see 'runtimepath' for 

details.

# Requirements

This script requires tlib ([vimscript #1863](http://www.vim.org/scripts/script.php?script_id=1863)) to be installed -- see 

https://github.com/tomtom/tlib_vim.

Dependencies:



tlib (>= 1.22)

http://github.com/tomtom/tlib_vim



License: GPLv3 or later