README.md
15f14b2b
 # lisaClust
abe74dd6
 
5bb30f41
 <img src="https://raw.githubusercontent.com/ellispatrick/lisaClust/master/inst/lisaClust_sticker_ai_upscaled.png" align="right" width="200" />
 
71e82e17
 Clustering of Local Indicators of Spatial Association
abe74dd6
 
15f14b2b
 ## Overview
 
abe74dd6
 
9125a9c4
 **lisaClust** provides a series of functions to identify and visualise 
     regions of tissue where spatial associations between cell-types is similar.
     This package can be used to provide a high-level summary of cell-type 
15f14b2b
     colocalisation in multiplexed imaging data that has been segmented at a 
9125a9c4
     single-cell resolution.
abe74dd6
 
15f14b2b
 ## Installation
 
 
 For the Bioconductor release version, run the following.
 ```r
 if (!require("BiocManager", quietly = TRUE))
     install.packages("BiocManager")
 
 BiocManager::install("lisaClust")
 ```
abe74dd6
 
15f14b2b
 If you would like the most up-to-date features, install the most recent development version.
abe74dd6
 ```r
15f14b2b
 # Install the development version from Bioconductor:
 if (!require("BiocManager", quietly = TRUE))
     install.packages("BiocManager")
 
 # The following initializes usage of Bioc devel
 # This will update all your Bioconductor packages to devel version
 BiocManager::install(version='devel')
 
 BiocManager::install("lisaClust")
 
 # Otherwise install the development version from GitHub:
abe74dd6
 # install.packages("devtools")
9125a9c4
 devtools::install_github("ellispatrick/lisaClust")
15f14b2b
 library(lisaClust)
abe74dd6
 ```
15f14b2b
 ## Submitting an issue or feature request
abe74dd6
 
9125a9c4
 `listClust` is still under active development. We would greatly appreciate any and 
abe74dd6
 all feedback related to the package.
 
9125a9c4
 * R package related issues should be raised [here](https://github.com/ellispatrick/listClust/issues).
abe74dd6
 * For general questions and feedback, please contact us directly via [[email protected]](mailto:[email protected]).
 
 
15f14b2b
 ## Authors
abe74dd6
 
 * **Nicolas Canete**
 * **Ellis Patrick**  - [@TheEllisPatrick](https://twitter.com/TheEllisPatrick)
 
c0c97c06
 ## Citation
 
 Patrick, E, Canete, NP, Iyengar, SS, Harman, AN, Sutherland, GT, Yang, P. Spatial analysis for highly multiplexed imaging data to identify tissue microenvironments. *Cytometry*. 2023. <https://doi.org/10.1002/cyto.a.24729>