Execute each line in a file as Vim commands. Include Vim
commands map, imap, nmap and vmap in your file to customise your
source editor keybindings.
Use rsvim_exec_file() to execute all of the commands. Bindings persist
for the duration of the RStudio session.
Use rsvim_exec_file(rprofile = TRUE) in your .Rprofile to execute the
commands on RStudio startup, so they are always active.
Usage
rsvim_exec_file(con = rsvim_default_path(), rprofile = FALSE, wait = 0)Arguments
- con
A string file path or connection object for a file with Vim commands to execute.
- rprofile
Logical. Set to
TRUEif calling this function within the.Rprofilei.e. before the RStudio API is available. This changes the behaviour from immediate execution to waiting for the RStudio API to become available. Currently only works on RStudio startup, not any R session restart.- wait
Numeric. Seconds to delay between typing the command and pressing enter. This can give time to review commands for testing and troubleshooting.
Details
You can execute a command from Vim normal mode manually by pressing
: to enter command mode, typing your command and then pressing Enter.
To use this function you write these commands in your file
passed to con. You can include comments in lines starting with double
quotes ". Each command should be on it's own line, like:
imap jk <Esc>
This function will simulate the key presses to execute the commands in your
file. The default file is called .vimrc, but it can be any file with text
in the right format.
Rprofile execution
When rprofile = TRUE this function uses setHook() to wait for the RStudio
API to become available before executing the commands. This is only triggered
the first time the RStudio session is opened, so not on every R session
restart.
See also
rsvim_exec() to execute individual commands.
rsvim_default_path() to get the default file path.
Examples
if (FALSE) { # \dontrun{
# Execute interactively:
rsvim_exec_file()
# Execute on startup with this in your .Rprofile file:
if (interactive()) rsvim_exec_file(rprofile = TRUE)
} # }