https://github.com/derthorsten/xeus-r
Xeus-based Jupyter kernel for R
https://github.com/derthorsten/xeus-r
Last synced: 5 months ago
JSON representation
Xeus-based Jupyter kernel for R
- Host: GitHub
- URL: https://github.com/derthorsten/xeus-r
- Owner: DerThorsten
- License: other
- Created: 2022-01-05T09:22:17.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-05T10:36:30.000Z (over 4 years ago)
- Last Synced: 2025-04-09T00:05:32.179Z (about 1 year ago)
- Language: CMake
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/SylvainCorlay/xeus-r/actions/workflows/main.yml)
[](https://xeus-rreadthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/SylvainCorlay/xeus-r/main?urlpath=/lab/tree/notebooks/xeus-r.ipynb)
`xeus-r` is a Jupyter kernel for R based on the native implementation of the
Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).
## Installation
xeus-r has not been packaged for the mamba (or conda) package manager.
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](https://github.com/conda-forge/miniforge#mambaforge) or
[miniconda](https://conda.io/miniconda.html) installation because with the full
[anaconda](https://www.anaconda.com/) you may have a conflict with the `zeromq` library
which is already installed in the anaconda distribution.
The safest usage is to create an environment named `xeus-r`
```bash
mamba create -n `xeus-r`
source activate `xeus-r`
```
### Installing from source
Or you can install it from the sources, you will first need to install dependencies
```bash
mamba install cmake xeus nlohmann_json cppzmq xtl jupyterlab -c conda-forge
```
Then you can compile the sources (replace `$CONDA_PREFIX` with a custom installation
prefix if need be)
```bash
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](https://github.com/jupyter-xeus/xeus)
- [xtl](https://github.com/xtensor-stack/xtl)
- [nlohmann_json](https://github.com/nlohmann/json)
- [RInside](https://github.com/eddelbuettel/rinside)
- [RCpp](https://github.com/RcppCore/Rcpp)
## Contributing
See [CONTRIBUTING.md](./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](LICENSE)
file for details.