Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/marchinilab/dropsim

R Package for Single Cell RNAseq Synthetic Data Simulation
https://github.com/marchinilab/dropsim

r-package scrnaseq simulation single-cell

Last synced: 24 days ago
JSON representation

R Package for Single Cell RNAseq Synthetic Data Simulation

Lists

README

        

# dropsim: Single Cell RNAseq Simulator

This is an R package for quickly simulating single cell RNAseq read count data. The model is based on data from droplet based methods, for other methods [Splatter](https://github.com/Oshlack/splatter) may be better suited. Sinsynthr shares a similar core model to Splatter but is overall much simpler.

## Installation

```R
# install.packages("devtools")
devtools::install_github("marchinilab/dropsim")
```

## Quick Start
```R
library(dropsim)

# Use default parameters
new_parameters <- dropsim_parameters()

# Simulate counts
simulation <- simulateDGE(new_parameters)

# Normalise Counts matrix
normalised_dge <- normaliseDGE(simulation$counts)

# Do a PCA to check
dge_pca <- prcomp(normalised_dge)
qplot(dge_pca$x[,1], dge_pca$x[,2], colour=rownames(dge_pca$x)) + labs(colour="Group", y="PC2", x="PC1")
```

![PCA on simulated data](example.png)

For more detailed examples of how to use this package please see the [vignette](vignettes/vignette.md).

## Directory Organisation
The [R/](R/) directory contains source code of the functions to simulate the data.

The [man/](man/) directory contains the manual pages for the functions, compiled by roxygen.

The [vignettes/](vignettes/) directory contains uncompiled Rmarkdown with examples of use.

The [tests/](tests/) directory contains the unit tests which are carried out by the testthat R package.

Contributions of any size or form are welcome!