Update documentation
[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 ## Tutorial
13
14 A tutorial for loomR can be found [here](http://satijalab.org/loomR/loomR_tutorial.html). A full function and method reference can be found [here](http://satijalab.org/loomR/loomR.pdf).
15
16 ## Compatability with loompy
17
18 loomR aims to be completely compatible with loompy. Currently, loomR implements the following methods of the loompy API:
19  - map/apply
20  - create
21  - connect
22  - add layer
23  - add attriute
24
25 ## Dependencies
26
27 loomR depends on:
28  - [R](https://cran.r-project.org/) v3.4.x
29  - The [R6](https://cran.r-project.org/package=R6) package
30  - The [hdf5r](https://cran.r-project.org/package=hdf5r) package
31  - The [iterators](https://cran.r-project.org/package=iterators) package
32  - The [itertools](https://cran.r-project.org/package=itertools) package
33  - The HDF5 [C++ API](https://support.hdfgroup.org/HDF5/release/obtainsrc.html)
34
35 To get the HDF5 C++ API, please see the table below:
36
37 | Operating system | Command |
38 | ---------------- | ------- |
39 | macOS | Using [Homebrew](https://brew.sh/), `brew install hdf5` |
40 | Debian and Debian-based OSes | `sudo apt install libhdf5-dev` |
41 | Red Hat-based OSes | `sudo dnf install hdf5-devel` or `sudo yum install hdf5-devel` |
42 | Windows | Download precombiled binaries from Mario Annau [here](https://github.com/mannau/h5-libwin) |