RWrapR

PyPI Status Python Version License

Documentation Tests Coverage Quality Gate Status

pre-commit Black Ruff Poetry

Features

RWrapR is a python package for using R inside of python. It is built using rpy2, but attempts to be more convient to use. Ideally you should never have to worry about using R objects, instead treating R functions as normal python functions, where the inputs and outputs are python objects.

import rwrapr as wr
import pandas as pd
import numpy as np

dplyr = wr.library("dplyr")
dt = wr.library("datasets")

dplyr.last(x=np.array([1, 2, 3, 4]))
dplyr.last(x=[1, 2, 3, 4])

iris = dt.iris
df = dplyr.mutate(iris, Sepal=wr.Lazily("round(Sepal.Length * 2, 0)"))

To do

1. Better warning handling (this will likely be tricky)
    - Sometimes we will get datatypes which are incompatible,
        e.g., warning accompanied by
2. Better handling of missing values.

Requirements

  • R must be installed

Installation

You can install RWrapR via pip from PyPI:

pip install rwrapr

Usage

Please see the [Reference Guide] for details.

Managing R dependencies

RWrapR will automatically install the required R packages, using the global library path. Sometimes this is not desirable, and you may want to use the renv package to manage your R dependencies. To do this, you can use renv via the rwrapr package.

import rwrapr as wr

renv = wr.library("renv") # note you must install renv globally first
renv.init() # initialize renv

renv.install("statisticsnorway/ssb-metodebiblioteket")
renv.install("metodebiblioteket")

renv.snapshot(type="all") # update lock-file

If you are using .ipynb files, you can should add renv.autoload() to the top of your notebook to ensure that the correct R environment is loaded.

For further details, see the Renv Article

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, RWrapR is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from Statistics Norway’s SSB PyPI Template.