https://github.com/rpy2/rpy2

Interface to use R from Python
https://github.com/rpy2/rpy2

cffi data-science interoperability python r statistics

Last synced: about 5 hours ago
JSON representation

Interface to use R from Python

• Host: GitHub
• URL: https://github.com/rpy2/rpy2
• Owner: rpy2
• License: gpl-2.0
• Created: 2018-12-14T18:51:22.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T03:58:55.000Z (17 days ago)
• Last Synced: 2024-10-24T15:55:26.792Z (17 days ago)
• Topics: cffi, data-science, interoperability, python, r, statistics
• Language: Python
• Homepage: https://rpy2.github.io
• Size: 29 MB
• Stars: 561
• Watchers: 8
• Forks: 73
• Open Issues: 154
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• jimsghstars - rpy2/rpy2 - Interface to use R from Python (Python)

README

        
# Python -> R bridge

[![pypi](https://img.shields.io/pypi/v/rpy2.svg?style=flat-square)](https://pypi.python.org/pypi/rpy2)

[![Codecov](https://codecov.io/gh/rpy2/rpy2/branch/master/graph/badge.svg)](https://codecov.io/gh/rpy2/rpy2)

[![GH Actions](https://github.com/rpy2/rpy2/workflows/Python%20package/badge.svg)](https://github.com/rpy2/rpy2/actions?query=workflow%3A%22Python+package%22)

The project's webpage is here: https://rpy2.github.io/

# Installation

`pip` should work out of the box:

```bash

pip install rpy2

```

The package has optional depencies providing

specific functionalities not otherwise required to use the rest of rpy2.

For example, to be able to run the unit tests:

```bash

pip install rpy2[test]

```

To install all optional dependencies (numpy, pandas, ipython), use:

```bash

pip install rpy2[all]

```

The package is known to compile on Linux, MacOSX

(provided that developper tools are installed, and you are ready

figure out how by yourself). The situation is currently a little

more complicated on Windows. Check the issue tracker.

In case you find yourself with this source without any idea

of what it takes to compile anything on your platform, try first

```bash

python setup.py install

```

## Issues loading shared C libraries

Whenever R is in not installed in a system location, the system might not

know where to find the R shared library.

If `R` is in the `PATH`, that is entering `R` on the command line successfully starts

an R terminal, but rpy2 does not work because of missing C libraries, try the following

before starting Python:

```bash

export LD_LIBRARY_PATH="$(python -m rpy2.situation LD_LIBRARY_PATH)":${LD_LIBRARY_PATH}

```

# Documentation

Documentation is available either in the source tree (`doc/`),

or [online](https://rpy2.github.io/doc.html).

## Testing

`rpy2` uses `pytest`, with the plugin `pytest-cov` for code coverage. To

test the package from the source tree, either to check and installation

on your system or before submitting a pull request, do:

```bash

pytest tests/

```

For code coverage, do:

```bash

pytest --cov=rpy2.rinterface_lib \

       --cov=rpy2.rinterface \

       --cov=rpy2.ipython \

       --cov=rpy2.robject \

       tests

```

For more options, such as how to run specify tests, please refer to the `pytest`

documentation.

# License

RPy2 can be used under the terms of the GNU

General Public License Version 2 or later (see the file

gpl-2.0.txt). This is the very same license R itself is released under.