README.md

In eddelbuettel/rcppredis: 'Rcpp' Bindings for 'Redis' using the 'hiredis' Library

RcppRedis: RcppRedis is a Rcpp and hiredis-based Redis client for R

Dependencies

The package has three dependencies that should be easily resolvable:

• hiredis, the main C library for Redis, eg via libhiredis-dev on Debian or Ubuntu; as a fallback hiredis is also included
• Rcpp for seamless R and C++ integration (on CRAN)
• RApiSerialize for C-level serialization from the R API (on CRAN) , and if so, of sufficient vintage80

The package should install from source like any other R package. If the a hiredis library is found, it will be used. The pkg-config script is used to find the hiredis headers and library. Otherwise the embedded hiredis is used. All of Rcpp, RApiSerialized and RcppRedis can be installed directly from CRAN (which is the recommended approach) or GitHub.

MessagePack support is optional, and provided by RcppMsgPack package on CRAN which, if installed, is used to provide MessagePack headers for MessagePack serialization.

Getting Started

Run some of the scripts from the demo/ directory.

Status

The package works well, is used in production, and has been on CRAN for some time.

It is however only providing a subset of the Redis API.

History

This package was derived from an initial fork of an earlier attempt named 'rhiredis' by Wush Wu, and has since been extended in a number of ways. William Pleasant provided some early patches. Whit Armstrong and Russell Pierce contributed extensions.

Authors

Dirk Eddelbuettel and Bryan W. Lewis, based on earlier work by Wush Wu and with contributions by William Pleasant, Russell Pierce and Whit Armstrong.

License

GPL (>= 2)

eddelbuettel/rcppredis documentation built on April 8, 2024, 1:10 a.m.