Add overwrite to add layer and add atribute
[loomr.git] / README.md
1 <!--
2 [![CRAN Version](https://www.r-pkg.org/badges/version/loomR)](https://cran.r-project.org/package=loomR) 
3 [![CRAN Downloads](https://cranlogs.r-pkg.org/badges/loomR)](https://cran.r-project.org/package=loomR)
4 -->
5
6 # loomR
7
8 ### An R interface for loom files
9
10 For more information on loom files, please see the documentation for [loompy](https://github.com/linnarsson-lab/loompy)
11
12 ## Compatability with loompy
13
14 loomR aims to be completely compatible with loompy. Currently, loomR implements the following methods of the loompy API:
15  - map/apply
16  - create
17  - connect
18  - add layer
19  - add attriute
20
21 ## Dependencies
22
23 loomR depends on:
24  - [R](https://cran.r-project.org/) v3.4.x
25  - The [R6](https://cran.r-project.org/package=R6) package
26  - The [hdf5r](https://cran.r-project.org/package=hdf5r) package
27  - The [iterators](https://cran.r-project.org/package=iterators) package
28  - The [itertools](https://cran.r-project.org/package=itertools) package
29  - The HDF5 [C++ API](https://support.hdfgroup.org/HDF5/release/obtainsrc.html)
30
31 To get the HDF5 C++ API, please see the table below:
32
33 | Operating system | Command |
34 | ---------------- | ------- |
35 | macOS | Using [Homebrew](https://brew.sh/), `brew install hdf5` |
36 | Debian and Debian-based OSes | `sudo apt install libhdf5-dev` |
37 | Red Hat-based OSes | `sudo dnf install hdf5-devel` or `sudo yum install hdf5-devel` |
38 | Windows | Download precombiled binaries [here](https://github.com/mannau/h5-libwin) |