A 21 century R console
radian is an alternative console for the R program with multiline editing and rich syntax highlight.
One would consider radian as a ipython clone for R, though its design is more aligned to julia.
; to enter and <backspace> to leave~ to enterjedi)Requirements:
python (version 3.7 or above) is also required to install radian. If your system doesn’t come with a python distribution, it can be downloaded from https://www.python.org/downloads/ or https://conda.io/en/latest/miniconda.html.pip is optional but it makes the installation a bit easier.
# install released versionpip3 install -U radian# to run radianradian
# or the development versionpip3 install -U git+https://github.com/randy3k/radian
Alternatively, if you use conda or miniconda,
conda install -c conda-forge radian
In this case, it is recommended to install R via conda to ensure consistency in C runtime libraries.
You could alias r to radian by putting
alias r="radian"
in ~/.bash_profile such that r would open radian and R would still open the traditional R console.
(R is still useful, e.g, running R CMD BUILD.)
radian can be customized by specifying the below options in various locations
$XDG_CONFIG_HOME/radian/profile or $HOME/.config/radian/profile (Unix)%USERPROFILE%/radian/profile (Windows)$HOME/.radian_profile (Unix)%USERPROFILE%/.radian_profile (Windows).radian_profile in the working directoryThe options could be also specified in the .Rprofile files, however,
it is not recommended because
packrat or renv.
# Do not copy the whole configuration, just specify what you need!# see https://pygments.org/styles# for a list of supported color schemes, default scheme is "native"options(radian.color_scheme = "native")# either `"emacs"` (default) or `"vi"`.options(radian.editing_mode = "emacs")# enable various emacs bindings in vi insert modeoptions(radian.emacs_bindings_in_vi_insert_mode = FALSE)# show vi mode state when radian.editing_mode is `vi`options(radian.show_vi_mode_prompt = TRUE)options(radian.vi_mode_prompt = "\033[0;34m[{}]\033[0m ")# indent continuation lines# turn this off if you want to copy code without the extra indentation;# but it leads to less elegent layoutoptions(radian.indent_lines = TRUE)# auto match brackets and quotesoptions(radian.auto_match = TRUE)# enable the [prompt_toolkit](https://python-prompt-toolkit.readthedocs.io/en/master/index.html) [`auto_suggest` feature](https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html#auto-suggestion)# this option is experimental and is known to break python prompt, use it with cautionoptions(radian.auto_suggest = FALSE)# highlight matching bracketoptions(radian.highlight_matching_bracket = FALSE)# auto indentation for new line and curly bracesoptions(radian.auto_indentation = TRUE)options(radian.tab_size = 4)# pop up completion while typingoptions(radian.complete_while_typing = TRUE)# the minimum length of prefix to trigger auto completionsoptions(radian.completion_prefix_length = 2)# timeout in seconds to cancel completion if it takes too long# set it to 0 to disable itoptions(radian.completion_timeout = 0.05)# add spaces around equals in function argument completionoptions(radian.completion_adding_spaces_around_equals = TRUE)# automatically adjust R buffer size based on terminal widthoptions(radian.auto_width = TRUE)# insert new line between promptsoptions(radian.insert_new_line = TRUE)# max number of history recordsoptions(radian.history_size = 20000)# where the global history is stored, environmental variables will be expanded# note that "~" is expanded to %USERPROFILE% or %HOME% in Windowsoptions(radian.global_history_file = "~/.radian_history")# the filename that local history is stored, this file would be used instead of# `radian.global_history_file` if it exists in the current working directoryoptions(radian.local_history_file = ".radian_history")# when using history search (ctrl-r/ctrl-s in emacs mode), do not show duplicate resultsoptions(radian.history_search_no_duplicates = FALSE)# ignore case in history searchoptions(radian.history_search_ignore_case = FALSE)# do not save debug browser commands such as `Q` in historyoptions(radian.history_ignore_browser_commands = TRUE)# custom prompt for different modesoptions(radian.prompt = "\033[0;34mr$>\033[0m ")options(radian.shell_prompt = "\033[0;31m#!>\033[0m ")options(radian.browse_prompt = "\033[0;33mBrowse[{}]>\033[0m ")# stderr color formatoptions(radian.stderr_format = "\033[0;31m{}\033[0m")# enable reticulate prompt and trigger `~`options(radian.enable_reticulate_prompt = TRUE)
# allows user defined shortcuts, these keys should be escaped when send through the terminal.# In the following example, `esc` + `-` sends `<-` and `ctrl` + `right` sends `%>%`.# Note that in some terminals, you could mark `alt` as `escape` so you could use `alt` + `-` instead.# Also, note that some ctrl mappings are reserved. You cannot remap m, i, h, d, or coptions(radian.escape_key_map = list(list(key = "-", value = " <- "),),radian.ctrl_key_map = list(list(key = "right", value = " %>% ")))
The latest version of R supports Unicode codepage directly. However, radian relies on Python and Python doesn’t support Unicode in the way that R supports it. A workaround could be found here: https://github.com/randy3k/radian/issues/269#issuecomment-1169663251. Though it may break the ploting device (running plot() will kill radian).
It is expected. radian runs on python and the python runtime used by radian is forced in
reticulate. reticulate::py_config() gives the note:
NOTE: Python version was forced by the current process
In order to use radian with another python runtime, you will need to install radian on
that python environment.
There are serveral options.
--r-binary, i.e., radian --r-binary=/path/to/RPATH variableR_BINARY could also be used to specify the path to R.R_HOME could also be used to specify R home directory. Note that it is should be set as the result of R.home(), not the directory where R is located. For example, in Unix
$ env R_HOME=/usr/local/lib/R radian
Please also make sure that R was installed with the R shared library libR.so or libR.dylib or libR.dll. On Linux, the configure flag ./configure --enable-R-shlib may be needed to install R from the source. Do not forget to make clean to force the recompilation of the files with the correct compiler options.
If you encounter
The package setup script has attempted to modify files on your system that are not within the EasyInstall build area.
Please update your setuptools by
pip install -U setuptools
radian maintains its own history file .radian_history and doesn’t use the .Rhistory file. A local .radian_history is used if it is found in the launch directory. Otherwise, the global history file ~/.radian_history would be used. To override the default behavior, you could launch radian with the options: radian --local-history, radian --global-history or radian --no-history.
radian only provides a frontend to the R program, the actual running eventloop is the same as that of the traditional R console. There is no performance sacrifice (or gain) while using this modern command line interface.
However, it was reported that radian may be slower when using parallel computation, specifially when using forking. User should take extra care in those cases.
Put
let R_app = "radian"let R_cmd = "R"let R_hl_term = 0let R_args = [] " if you had set anylet R_bracketed_paste = 1
in your vim config.
reticulate Auto CompletionsTo enable reticulate prompt completions, make sure that jedi is installed.
pip install jedi
Alternatively, if you use conda,
conda install -c conda-forge jedi
It maybe caused by the invalid terminal size, try running stty size in your terminal
to see if it returns a correct size. You could change the values of it from the environmental variables$COLUMNS and $LINES when you log-in the docker container.
docker exec -it <container> bash -c "stty cols $COLUMNS rows $LINES && bash"
radian is powered by (π)thon.
radian wouldn’t be possible without the creative work prompt_toolkit by Jonathan Slenders.