Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddelbuettel/rcppcnpy
Rcpp bindings for NumPy files
https://github.com/eddelbuettel/rcppcnpy
c-plus-plus cran numpy r r-package
Last synced: 6 days ago
JSON representation
Rcpp bindings for NumPy files
- Host: GitHub
- URL: https://github.com/eddelbuettel/rcppcnpy
- Owner: eddelbuettel
- License: gpl-2.0
- Created: 2013-11-28T16:28:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T19:26:48.000Z (4 months ago)
- Last Synced: 2024-12-08T22:04:02.528Z (15 days ago)
- Topics: c-plus-plus, cran, numpy, r, r-package
- Language: C++
- Size: 3.24 MB
- Stars: 27
- Watchers: 5
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
## RcppCNPy: Rcpp bindings for NumPy files
[](https://github.com/eddelbuettel/rcppcnpy/actions?query=workflow%3Aci)
[](http://www.gnu.org/licenses/gpl-2.0.html)
[](https://cran.r-project.org/package=RcppCNPy)
[](https://cran.r-project.org/package=RcppCNPy)
[](https://www.r-pkg.org:443/pkg/RcppCNPy)
[](https://github.com/eddelbuettel/rcppcnpy)
[](https://joss.theoj.org/papers/10.21105/joss.00055)
[](https://doi.org/10.5281/zenodo.155066)
### About
This package uses the [cnpy](https://github.com/rogersce/cnpy) library
written by Carl Rogers to provide read and write facilities for files created
with (or for) the NumPy extension for Python. Vectors and matrices of
numeric types can be read or written to and from files as well as compressed
files. Support for integer files is available if the package has been built
with `-std=c++11` which is the default starting with release 0.2.3 following
the release of R 3.1.0, and available on all platforms following the release
of R 3.3.0 with the updated 'Rtools'.
### Example
The following Python code
```{.python}
>>> import numpy as np
>>> fm = np.arange(12).reshape(3,4) * 1.1
>>> fm
array([[ 0. , 1.1, 2.2, 3.3],
[ 4.4, 5.5, 6.6, 7.7],
[ 8.8, 9.9, 11. , 12.1]])
>>> np.save("fmat.npy", fm)
>>>
>>> im = np.arange(12).reshape(3,4)
>>> im
array([[ 0, 1, 2, 3],
[ 4, 5, 6, 7],
[ 8, 9, 10, 11]])
>>> np.save("imat.npy", im)
>>>
```
saves two matrices in floating-point and integer representation.
With this R code we can read and assign the files:
```{.r}
R> library(RcppCNPy)
R> fmat <- npyLoad("fmat.npy")
R> fmat
[,1] [,2] [,3] [,4]
[1,] 0.0 1.1 2.2 3.3
[2,] 4.4 5.5 6.6 7.7
[3,] 8.8 9.9 11.0 12.1
R>
R> imat <- npyLoad("imat.npy", "integer")
R> imat
[,1] [,2] [,3] [,4]
[1,] 0 1 2 3
[2,] 4 5 6 7
[3,] 8 9 10 11
R>
```
Going the opposite way by saving in R and reading in Python works equally
well. An extension not present in [CNPy](https://github.com/rogersce/cnpy)
allows reading and writing of gzip-compressed files.
The package has been tested and used on several architecture, and copes
correctly with little-vs-big endian switches.
More details are available in the [package vignette](https://cran.r-project.org/package=RcppCNPy/vignettes/RcppCNPy-intro.pdf).
### Installation
The package is on [CRAN](https://cran.r-project.org) and can be installed per:
```{r}
R> install.packages("RcppCNPy")
```
### Status
On [CRAN](https://cran.r-project.org/package=RcppCNPy), stable and mostly
feature-complete.
### Alternative: [reticulate](https://github.com/rstudio/reticulate)
The [reticulate](https://github.com/rstudio/reticulate) package can also provide easy and comprehensive access
to NumPy data; see the
[additional vignette in RcppCNPy](https://cran.r-project.org/package=RcppCNPy/vignettes/UsingReticulate.pdf)
for examples and more details.
### Feedback
Contributions are welcome, please use the GitHub
[issue tracker](https://github.com/eddelbuettel/rcppcnpy/issues) for
bug reports, feature requests or general discussions before sending
[pull requests](https://github.com/eddelbuettel/rcppcnpy/pulls).
### Author
Dirk Eddelbuettel and Wush Wu
### License
GPL (>= 2)