<!--
[![CRAN Version](https://www.r-pkg.org/badges/version/loomR)](https://cran.r-project.org/package=loomR) 
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/loomR)](https://cran.r-project.org/package=loomR)
-->

# loomR

### An R interface for loom files

For more information on loom files, please see the documentation for [loompy](https://github.com/linnarsson-lab/loompy)

## Tutorial

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).

## Compatability with loompy

loomR aims to be completely compatible with loompy. Currently, loomR implements the following methods of the loompy API:
 - map/apply
 - create
 - connect
 - add layer
 - add attriute

## Dependencies

loomR depends on:
 - [R](https://cran.r-project.org/) v3.4.x
 - The [R6](https://cran.r-project.org/package=R6) package
 - The [hdf5r](https://cran.r-project.org/package=hdf5r) package
 - The [iterators](https://cran.r-project.org/package=iterators) package
 - The [itertools](https://cran.r-project.org/package=itertools) package
 - The HDF5 [C++ API](https://support.hdfgroup.org/HDF5/release/obtainsrc.html)

To get the HDF5 C++ API, please see the table below:

| Operating system | Command |
| ---------------- | ------- |
| macOS | Using [Homebrew](https://brew.sh/), `brew install hdf5` |
| Debian and Debian-based OSes | `sudo apt install libhdf5-dev` |
| Red Hat-based OSes | `sudo dnf install hdf5-devel` or `sudo yum install hdf5-devel` |
| Windows | Download precombiled binaries from Mario Annau [here](https://github.com/mannau/h5-libwin) |