README.Rmd

---
output: github_document
---

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

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

# CytoSpill

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

The goal of CytoSpill is to compensate the spillover effects in CyTOF data which caused by technical effects without relying on control experiment.

## Installation

You can install the development version of CytoSpill from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("KChen-lab/CytoSpill")
```
## Example

This is a example which shows you how to compensate a CyTOF dataset, we used a sample dataset that included in our package here:

```{r}
devtools::load_all()
library(CytoSpill)
getwd()
load(file="./data/Levine32_example.RData")
str(data_Levine32)
```

We sampled 10,000 cells from the healthy human bone marrow data used in Levine, 2015. 
We can check the colunmns of this CyTOF dataset:

```{r cols}
colnames(data_Levine32)
```

And the corresponding markers:

```{r markers}
markers
```

After checking the markers we decided to use columns 5 to 36 for compensation.
We can use the function SpillComp to estimate the spillover matrix and perform compensation. We need to specify the data we are using, which column are used to calculate the spillover effects and using how many cells for calculation.

```{r eval=FALSE}
results <- SpillComp(data = data_Levine32, cols = 5:36, n = 10000, threshold = 0.1, flexrep = 5, neighbor = 1)
```

The function returns a list of results, the first element is the compensated data matrix in flowFrame format, the second one is the estimated spillover matrix and the third one is the derived cutoffs based on our method.