Skip to content

A computational toolkit in R for the integration, exploration, and analysis of high-dimensional single-cell cytometry and imaging data.

License

Notifications You must be signed in to change notification settings

ImmuneDynamics/Spectre

Repository files navigation

Spectre

A computational toolkit in R for the integration, exploration, and analysis of high-dimensional single-cell cytometry and imaging data.

Current version: v1.2.0

R-CMD-check AppVeyor build status


About

Spectre is an R package that enables comprehensive end-to-end integration and analysis of high-dimensional cytometry data from different batches or experiments. Spectre streamlines the analytical stages of raw data pre-processing, batch alignment, data integration, clustering, dimensionality reduction, visualisation and population labelling, as well as quantitative and statistical analysis. To manage large cytometry datasets, Spectre was built on the data.table framework -- this simple table-like structure allows for fast and easy processing of large datasets in R. Critically, the design of Spectre allows for a simple, clear, and modular design of analysis workflows, that can be utilised by data and laboratory scientists. Recently we have extended the functionality of Spectre to support the analysis of Imaging Mass Cytometry (IMC) and scRNAseq data. For more information, please see our paper: Ashhurst TM, Marsh-Wakefield F, Putri GH et al. (2022). Cytometry A. DOI: 10.1002/cyto.a.24350.


Getting started

We provide a variety of workflows and tutorials on our main page here: https://immunedynamics.github.io/spectre

Installation

We recommend using Spectre with R and RStudio. Once R and RStudio are installed, run the following to install the Spectre package.

if(!require('remotes')) {install.packages('remotes')} # Installs the package 'remotes'
remotes::install_github(repo = "immunedynamics/spectre") # Install the Spectre package

If you are unfamiliar with using R and RStudio, check out our R and Spectre basics guides for assistance. For detailed installation instructions, and instructions for installing Spectre via Docker, see our installation guide.

New to R or Spectre?

New users can check out our basics guides to get acquainted with using R and Spectre.

Workflows and protocols

When you are ready to start analysis, check out our structured workflows and tutorials on the following pages:


Citation

If you use Spectre in your work, please consider citing Ashhurst TM, Marsh-Wakefield F, Putri GH et al. (2022). Cytometry A. DOI: 10.1002/cyto.a.24350. To continue providing open-source tools such as Spectre, it helps us if we can demonstrate that our efforts are contributing to analysis efforts in the community. Please also consider citing the authors of the individual packages or tools (e.g. CytoNorm, FlowSOM, tSNE, UMAP, etc) that are critical elements of your analysis work.