Repository files navigation

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

Released versions can be installed from a package repository (defaultbeing pypi) using pip:

pip install rpy2

The package has optional depencies providingspecific functionalities not otherwise required to use the rest of rpy2.

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

pip install'rpy2[test]'

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

pip install'rpy2[all]'

If a developer, the package can be installed from its source tree.rpy2 is a namespace package with its consituting parts in different"sub-packages".

To install from the source tree, just enter:

pip install ./rpy2-rinterface/ ./rpy2-robjects/.

Various optional dependencies can be specified through dependency groups.For example:

pip install ./rpy2-rinterface'[all]' ./rpy2-robjects'[all]''.[all]'

rpy2-rinterface contains the binding to R's C API. Building fromsource require a compilation toolchain / developper tools installed,and you will have to figure out how to have them installed on yoursystem by yourself. The CI pipeline builds binary wheels for Linux,MacOS, and Windows. Watching how things are set up there is prettymuch all documentation from the package maintainers on the matter.

Whenever R is in not installed in a system location, the system might notknow where to find the R shared library.

IfR is in thePATH, that is enteringR on the command line successfully startsan R terminal, but rpy2 does not work because of missing C libraries, try the followingbefore starting Python:

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

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

rpy2 usespytest, with the pluginpytest-cov for code coverage. Totest the package from the source tree, either to check and installationon your system or before submitting a pull request, do:

pytest rpy2-rinterface/ rpy2-robjects/

For code coverage, do:

pytest --cov=rpy2.rinterface_lib \       --cov=rpy2.rinterface \       --cov=rpy2.ipython \       --cov=rpy2.robject \       rpy2-rinterface/ rpy2-robjects/

For more options, such as how to run specify tests, please refer to thepytestdocumentation.

RPy2 can be used under the terms of the GNUGeneral Public License Version 2 or later (see the filegpl-2.0.txt). This is the very same license R itself is released under.