Learn R Programming

Seurat v5

Seurat is an R toolkit for single cell genomics, developed and maintained by the Satija Lab at NYGC.

We are excited to release Seurat v5! This updates introduces new functionality for spatial, multimodal, and scalable single-cell analysis.

Seurat v5 is backwards-compatible with previous versions, so that users will continue to be able to re-run existing workflows.

Instructions, documentation, and tutorials can be found at:

Seurat is also hosted on GitHub, you can view and clone the repository at

Seurat has been successfully installed on Mac OS X, Linux, and Windows, using the devtools package to install directly from GitHub

Improvements and new features will be added on a regular basis, please post on the github page with any questions or if you would like to contribute

For a version history/changelog, please see the NEWS file.

Copy Link

Version

Install

install.packages('Seurat')

Monthly Downloads

39,699

Version

5.2.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Paul Hoffman

Last Published

January 13th, 2025

Functions in Seurat (5.2.0)

CCAIntegration

Seurat-CCA Integration
BuildClusterTree

Phylogenetic Analysis of Identity Classes
BGTextColor

Determine text color based on background color
CalculateBarcodeInflections

Calculate the Barcode Distribution Inflection
BridgeReferenceSet-class

The BridgeReferenceSet Class The BridgeReferenceSet is an output from PrepareBridgeReference
BarcodeInflectionsPlot

Plot the Barcode Distribution and Calculated Inflection Points
BridgeCellsRepresentation

Construct a dictionary representation for each unimodal dataset
BuildNicheAssay

Construct an assay for spatial niche analysis
CalcPerturbSig

Calculate a perturbation Signature
CalcDispersion

Calculate dispersion of features
CollapseSpeciesExpressionMatrix

Slim down a multi-species expression matrix, when only one species is primarily of interenst.
Cells.SCTModel

Get Cell Names
CellSelector

Cell Selector
CollapseEmbeddingOutliers

Move outliers towards center on dimension reduction plot
CaseMatch

Match the case of character vectors
CellScatter

Cell-cell scatter plot
ColorDimSplit

Color dimensional reduction plot by tree split
CellCycleScoring

Score cell cycle phases
CombinePlots

Combine ggplot2-based plots into a single plot
CellsByImage

Get a vector of cell names associated with an image (or set of images)
DISP

Find variable features based on dispersion
DimHeatmap

Dimensional reduction heatmap
DimPlot

Dimensional reduction plot
DEenrichRPlot

DE and EnrichR pathway visualization barplot
BlackAndWhite

Create a custom color palette
CustomDistance

Run a custom distance function on an input data matrix
CreateSCTAssayObject

Create a SCT Assay object
FastRPCAIntegration

Perform integration on the joint PCA cell embeddings.
FastRowScale

Scale and/or center matrix rowwise
DimReduc-class

The DimReduc Class
DiscretePalette

Discrete colour palettes from pals
DoHeatmap

Feature expression heatmap
DotPlot

Dot plot visualization
DietSeurat

Slim down a Seurat object
ExpSD

Calculate the standard deviation of logged values
FeaturePlot

Visualize 'features' on a dimensional reduction plot
FeatureScatter

Scatter plot of single cell data
ExpVar

Calculate the variance of logged values
FetchResiduals_reference

temporal function to get residuals from reference
FilterSlideSeq

Filter stray beads from Slide-seq puck
FindBridgeTransferAnchors

Find bridge anchors between query and extended bridge-reference
ExpMean

Calculate the mean of logged values
CreateCategoryMatrix

Create one hot matrix for a given label
CountSketch

Generate CountSketch random matrix
ElbowPlot

Quickly Pick Relevant Dimensions
FindBridgeIntegrationAnchors

Find integration bridge anchors between query and extended bridge-reference
FetchResidualSCTModel

Calculate pearson residuals of features not in the scale.data This function is the secondary function under FetchResiduals
FetchResiduals

Calculate pearson residuals of features not in the scale.data
FindAllMarkers

Gene expression markers for all identity classes
FindBridgeAnchor

Find bridge anchors between two unimodal datasets
FindVariableFeatures

Find variable features
FindTransferAnchors

Find transfer anchors
FindConservedMarkers

Finds markers that are conserved between the groups
FindClusters

Cluster Determination
GetResidual

Calculate pearson residuals of features not in the scale.data
FindSubCluster

Find subclusters under one cluster
FindSpatiallyVariableFeatures

Find spatially variable features
GetIntegrationData

Get integration data
GetImage.SlideSeq

Get Image Data
GetAssay

Get an Assay object from a given Seurat object.
GroupCorrelation

Compute the correlation of features broken down by groups with another covariate
HTOHeatmap

Hashtag oligo heatmap
GetTissueCoordinates.SlideSeq

Get Tissue Coordinates
Graph-class

The Graph Class
GetTransferPredictions

Get the predicted identity
HarmonyIntegration

Harmony Integration
FindNeighbors

(Shared) Nearest-neighbor graph construction
FindMultiModalNeighbors

Construct weighted nearest neighbor graph
GroupCorrelationPlot

Boxplot of correlation of a variable (e.g. number of UMIs) with expression data
HTODemux

Demultiplex samples based on data from cell 'hashing'
IFeaturePlot

Visualize features in dimensional reduction space interactively
HoverLocator

Hover Locator
FindIntegrationAnchors

Find integration anchors
FindMarkers

Gene expression markers of identity classes
ISpatialDimPlot

Visualize clusters spatially and interactively
GaussianSketch

Gaussian sketching
FoldChange

Fold Change
JackStraw

Determine statistical significance of PCA scores.
ISpatialFeaturePlot

Visualize features spatially and interactively
JackStrawData-class

The JackStrawData Class
ImageDimPlot

Spatial Cluster Plots
IntegrationData-class

The IntegrationData Class
IntegrationAnchorSet-class

The IntegrationAnchorSet Class
Load10X_Spatial

Load a 10x Genomics Visium Spatial Experiment into a Seurat object
LabelPoints

Add text labels to a ggplot2 plot
HVFInfo.SCTAssay

Get Variable Feature Information
LabelClusters

Label clusters on a ggplot2-based scatter plot
IntegrateLayers

Integrate Layers
IntegrateEmbeddings

Integrate low dimensional embeddings
L2CCA

L2-Normalize CCA
ImageFeaturePlot

Spatial Feature Plots
L2Dim

L2-normalization
MVP

Find variable features based on mean.var.plot
MetaFeature

Aggregate expression of multiple features into a single feature
LoadAnnoyIndex

Load the Annoy index file
MappingScore

Metric for evaluating mapping success
LoadCurioSeeker

Load Curio Seeker data
MapQuery

Map query cells to a reference
IntegrateData

Integrate data
MULTIseqDemux

Demultiplex samples based on classification method from MULTI-seq (McGinnis et al., bioRxiv 2018)
MinMax

Apply a ceiling and floor to all values in a matrix
JointPCAIntegration

Seurat-Joint PCA Integration
LoadSTARmap

Load STARmap data
MixingMetric

Calculates a mixing metric
LeverageScore

Leverage Score Calculation
LogVMR

Calculate the variance to mean ratio of logged values
JackStrawPlot

JackStraw Plot
ModalityWeights-class

The ModalityWeights Class
LinkedPlots

Visualize spatial and clustering (dimensional reduction) data in a linked, interactive framework
NNPlot

Highlight Neighbors in DimPlot
PrepSCTFindMarkers

Prepare object to run differential expression on SCT assay with multiple models
PrepSCTIntegration

Prepare an object list normalized with sctransform for integration.
NNtoGraph

Convert Neighbor class to an asymmetrical Graph class
PlotClusterTree

Plot clusters as a tree
MixscapeLDA

Linear discriminant analysis on pooled CRISPR screen data.
PlotPerturbScore

Function to plot perturbation score distributions.
MixscapeHeatmap

Differential expression heatmap for mixscape
NormalizeData

Normalize Data
RPCAIntegration

Seurat-RPCA Integration
PCASigGenes

Significant genes from a PCA
PolyDimPlot

Polygon DimPlot
PolyFeaturePlot

Polygon FeaturePlot
ProjectUMAP

Project query into UMAP coordinates of a reference
ProjectData

Project full data to the sketch assay
Radius.SlideSeq

Get Spot Radius
PredictAssay

Predict value from nearest neighbors
LocalStruct

Calculate the local structure preservation metric
PercentAbove

Calculate the percentage of a vector above some threshold
LogNormalize

Normalize Raw Data
PercentageFeatureSet

Calculate the percentage of all counts that belong to a given set of features
PrepLDA

Function to prepare data for Linear Discriminant Analysis.
ReadNanostring

Read and Load Nanostring SMI data
ReadParseBio

Read output from Parse Biosciences
Neighbor-class

The Neighbor Class
PrepareBridgeReference

Prepare the bridge and reference datasets
ProjectIntegration

Integrate embeddings from the integrated sketched.assay
ProjectDimReduc

Project query data to reference dimensional reduction
Read10X_ScaleFactors

Load 10X Genomics Visium Scale Factors
Read10X_Image

Load a 10X Genomics Visium Image
PseudobulkExpression

Pseudobulk Expression
ReadMtx

Load in data from remote or local mtx files
LoadXenium

Read and Load 10x Genomics Xenium in-situ data
ReadAkoya

Read and Load Akoya CODEX data
RunGraphLaplacian

Run Graph Laplacian Eigendecomposition
ReadVitessce

Read Data From Vitessce
RunICA

Run Independent Component Analysis on gene expression
ReadSTARsolo

Read output from STARsolo
ProjectDim

Project Dimensional reduction onto full dataset
ReadSlideSeq

Load Slide-seq spatial data
RegroupIdents

Regroup idents based on meta.data info
ReadVizgen

Read and Load MERFISH Input from Vizgen
ProjectCellEmbeddings

Project query data to the reference dimensional reduction
Read10X_Coordinates

Load 10X Genomics Visium Tissue Positions
Read10X

Load in data from 10X
RunTSNE

Run t-distributed Stochastic Neighbor Embedding
RelativeCounts

Normalize raw data to fractions
RunSPCA

Run Supervised Principal Component Analysis
RunSLSI

Run Supervised Latent Semantic Indexing
RenameCells.SCTAssay

Rename Cells in an Object
RunLeiden

Run Leiden clustering algorithm
RunLDA

Run Linear Discriminant Analysis
RunMoransI

Compute Moran's I value.
RunPCA

Run Principal Component Analysis
Read10X_h5

Read 10X hdf5 file
RidgePlot

Single cell ridge plot
RunCCA

Perform Canonical Correlation Analysis
Read10X_probe_metadata

Read10x Probe Metadata
RunMixscape

Run Mixscape
SampleUMI

Sample UMI
SaveAnnoyIndex

Save the Annoy index
RunMarkVario

Run the mark variogram computation on a given position matrix and expression matrix.
SCTAssay-class

The SCTModel Class
SCTResults

Get SCT results from an Assay
SelectIntegrationFeatures

Select integration features
ScoreJackStraw

Compute Jackstraw scores significance.
RunUMAP

Run UMAP
SingleCorPlot

A single correlation plot
Seurat-class

The Seurat Class
SelectSCTIntegrationFeatures

Select SCT integration features
SelectIntegrationFeatures5

Select integration features
SingleDimPlot

Plot a single dimension
SeuratCommand-class

The SeuratCommand Class
STARmap-class

The STARmap class
SCTransform

Perform sctransform-based normalization
SeuratTheme

Seurat Themes
SplitObject

Splits object into a list of subsetted objects.
SpatialPlot

Visualize spatial clustering and expression data.
SetIntegrationData

Set integration data
SetQuantile

Find the Quantile of Data
SketchData

Sketch Data
SingleSpatialPlot

Base plotting function for all Spatial plots
ScaleData

Scale and center the data.
ScaleFactors

Get image scale factors
UpdateSCTAssays

Update pre-V4 Assays generated with SCTransform in the Seurat to the new SCTAssay class
SingleRasterMap

A single heatmap from ggplot2 using geom_raster
SingleImageMap

SingleImagePlot

Single Spatial Plot
UnSketchEmbeddings

Transfer embeddings from sketched cells to the full data
TransferSketchLabels

Transfer data from sketch data to full data
SingleExIPlot

Plot a single expression by identity on a plot
Seurat-package

Seurat: Tools for Single Cell Genomics
SubsetByBarcodeInflections

Subset a Seurat Object based on the Barcode Distribution Inflection Points
TopCells

Find cells with highest scores for a given dimensional reduction technique
SlideSeq-class

The SlideSeq class
UpdateSymbolList

Get updated synonyms for gene symbols
TransferAnchorSet-class

The TransferAnchorSet Class
SpatialImage-class

The SpatialImage Class
as.sparse.H5Group

Cast to Sparse
as.SingleCellExperiment

Convert objects to SingleCellExperiment objects
VisiumV1-class

The VisiumV1 class
VisiumV2-class

The VisiumV2 class
contrast-theory

Get the intensity and/or luminance of a color
fortify-Spatial

Prepare Coordinates for Spatial Plots
VizDimLoadings

Visualize Dimensional Reduction genes
VlnPlot

Single cell violin plot
TransferData

Transfer data
subset.AnchorSet

Subset an AnchorSet object
cc.genes.updated.2019

Cell cycle genes: 2019 update
cc.genes

Cell cycle genes
VST

Variance Stabilizing Transformation
VariableFeaturePlot

View variable features
TopFeatures

Find features with highest scores for a given dimensional reduction technique
merge.SCTAssay

Merge SCTAssay objects
writing-integration

Writing Integration Method Functions
components

Objects exported from other packages
TopNeighbors

Get nearest neighbors for given cell
as.CellDataSet

Convert objects to CellDataSet objects
as.Seurat.CellDataSet

Convert objects to Seurat objects
AutoPointSize

Automagically calculate a point size for ggplot2-based scatter plots
AnnotateAnchors

Add info to anchor matrix
AddAzimuthScores

Add Azimuth Scores
AugmentPlot

Augments ggplot2-based plot with a PNG image.
AddModuleScore

Calculate module scores for feature expression programs in single cells
AverageExpression

Averaged feature expression by identity class
AddAzimuthResults

Add Azimuth Results
AnchorSet-class

The AnchorSet Class
AggregateExpression

Aggregated feature expression by identity class
Assay-class

The Assay Class