README.md

diffcyt

Build Status codecov

Summary

diffcyt: R package for differential discovery in high-dimensional cytometry via high-resolution clustering

The diffcyt package implements statistical methods for differential discovery analyses in high-dimensional cytometry data (including flow cytometry, mass cytometry or CyTOF, and oligonucleotide-tagged cytometry), based on a combination of high-resolution clustering and empirical Bayes moderated tests adapted from transcriptomics.

Details

For details on the statistical methodology and comparisons with existing approaches, see our paper introducing the diffcyt framework, available as a preprint from bioRxiv:

Tutorial and examples

For a tutorial and examples of usage, see the Bioconductor package vignette (link also available via the main Bioconductor page for the diffcyt package).

Availability and installation

The diffcyt package is freely available from Bioconductor. The stable release version can be installed using the Bioconductor installer as follows. Note that installation requires R version 3.4.0 or later.

# Install Bioconductor installer from CRAN
install.packages("BiocManager")

# Install 'diffcyt' package from Bioconductor
BiocManager::install("diffcyt")

To run the examples in the package vignette and generate additional visualizations, the HDCytoData and CATALYST packages from Bioconductor are also required.

BiocManager::install("HDCytoData")
BiocManager::install("CATALYST")

Development version

If required, the development version of the diffcyt package can be installed through the devel version of Bioconductor or from GitHub. The development version may include additional updates that have not yet been included in the release version. Note that we recommend using the release version in most cases, since this has been more thoroughly tested.

To set up the devel version of Bioconductor, see the Bioconductor help pages. To install the development version of the diffcyt package directly from GitHub, use the devtools package as follows. When installing from GitHub, dependency packages will also need to be installed separately from CRAN and Bioconductor.

# Install 'devtools' package from CRAN
install.packages("devtools")

# Install development version of 'diffcyt' package from GitHub
library(devtools)
install_github("lmweber/diffcyt")


lmweber/diffcyt documentation built on March 16, 2021, 4:43 p.m.