README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
library("BiocStyle")
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# iSEEid

<!-- badges: start -->
<!-- badges: end -->

The goal of iSEEid is to use `iSEE` to `id`entify cells 

## Installation

Get the latest stable `R` release from [CRAN](http://cran.r-project.org/).  
Then, install `r Biocpkg("iSEEid")` from [Bioconductor](http://bioconductor.org/) using the following code:

```{r 'install', eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("iSEEid")
```

And the development version from [GitHub](https://github.com/iSEE/iSEEid) with:

```{r 'install_dev', eval = FALSE}
BiocManager::install("iSEE/iSEEid")
```

## Example

This is a basic example which shows you how to launch an application...

```{r example}
library("iSEEid")
## basic example code
```

> maybe put a screenshot at some point or a gif to illustrate how it could work

## Code of Conduct

Please note that the `r Biocpkg("iSEEid")` project is released with a [Contributor Code of Conduct](http://bioconductor.org/about/code-of-conduct/). 
By contributing to this project, you agree to abide by its terms.