README.md
4fc098e7
 # scTreeViz
21173cc8
 This package provides methods to interactively explore and visualize datasets with hierarchies. eg. single cells datasets with hierarchy over cells at different resolutions. 
cfe0b049
 
a8ab81c9
 For a walk through of various features of the app, checkout the vignette at 
2f959435
 
4fc098e7
 https://hcbravolab.github.io/scTreeViz/Explore-PBMC.html
2f959435
 
32e71557
 ## Installation and requirements
cfe0b049
 
4fc098e7
 `scTreeViz` currently requires a development version of `epivizrData` which supports Sparse Measurements. We plan to push this to `bioc` soon. 
21173cc8
 
4fc098e7
 To install `scTreeViz`, 
cfe0b049
 
0d5fc231
 ```{r}
d6b33c53
 BiocManager::install("epiviz/epivizrData")
4fc098e7
 BiocManager::install("HCBravoLab/scTreeViz")
0d5fc231
 ```
21173cc8
 ***Note: you can also use devtools to install the package from github***
0d5fc231
 
 ## Usage
 
21173cc8
 To try out and explore the various features of the package, we provide the PBMC 3K dataset and the vignette `Explore-PBMC` walks you through the process. 
 
 To checkout all the vignettes
0d5fc231
 
 ```{r}
4fc098e7
 library(scTreeViz)
 browseVignettes("scTreeViz")
2f959435
 ```