README.md

xeus-r is a Jupyter kernel for R based on the native implementation of the Jupyter protocol xeus.

Installation

xeus-r has been packaged for the mamba (or conda) package manager on the Linux, Windows, and OS X platforms.

To ensure that the installation works, it is preferable to install xeus-r in a fresh environment. It is also needed to use a miniforge or miniconda installation because with the full anaconda you may have a conflict with the zeromq library which is already installed in the anaconda distribution.

Installation with mamba or conda

The safest usage is to create an environment named xeus-r

mamba create -n xeus-r
mamba activate xeus-r

Then you can install in this environment xeus-r and its dependencies

mamba install xeus-r -c conda-forge

Installing from source

Or you can install it from the sources, you will first need to install dependencies

mamba install cmake cxx-compiler xeus-zmq nlohmann_json jupyterlab r-base r-evaluate r-rlang r-jsonlite r-glue r-cli r-repr r-irdisplay -c conda-forge

Then you can compile the sources (replace $CONDA_PREFIX with a custom installation prefix if need be)

mkdir build && cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make && make install

Documentation

To get started with using xeus-r, check out the full documentation

http://xeus-r.readthedocs.io

Dependencies

xeus-r depends on

• xeus-zmq
• nlohmann_json

xeus-r	xeus-zmq	nlohmann_json
main	>=3.0,<4.0	>=3.11.3
0.2.x	>=3.0,<4.0	>=3.11.3

Prior vo version 0.2, xeus-r was also depending on xtl & cppzmq:

xeus-r	xeus-zmq	xtl	cppzmq	nlohmann_json
0.1.x	>=1.0.0,<2.0	>=0.7.0,<0.8	~4.4.1	>=3.11.2

Contributing

See CONTRIBUTING.md to know how to contribute and set up a development environment.

License

This software is licensed under the GNU General Public License v3. See the LICENSE file for details.