Add ability to transpose input data
[loomr.git] / README.md
index 829bb789f225fae739be81d2a408e5813998115b..e43583e472b82c92d6c5d19c0b96d3074316311f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,19 @@
 
 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:
@@ -26,4 +39,4 @@ To get the HDF5 C++ API, please see the table below:
 | 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 [here](https://github.com/mannau/h5-libwin) |
+| Windows | Download precombiled binaries from Mario Annau [here](https://github.com/mannau/h5-libwin) |