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

49,115

Version

5.0.3

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

March 18th, 2024

Functions in Seurat (5.0.3)

AddAzimuthScores

Add Azimuth Scores
Assay-class

The Assay Class
AddModuleScore

Calculate module scores for feature expression programs in single cells
AugmentPlot

Augments ggplot2-based plot with a PNG image.
AnchorSet-class

The AnchorSet Class
AggregateExpression

Aggregated feature expression by identity class
BuildClusterTree

Phylogenetic Analysis of Identity Classes
BuildNicheAssay

Construct an assay for spatial niche analysis
CaseMatch

Match the case of character vectors
CellCycleScoring

Score cell cycle phases
AnnotateAnchors

Add info to anchor matrix
CCAIntegration

Seurat-CCA Integration
AutoPointSize

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

Averaged feature expression by identity class
BridgeCellsRepresentation

Construct a dictionary representation for each unimodal dataset
DimHeatmap

Dimensional reduction heatmap
CountSketch

Generate CountSketch random matrix
CreateCategoryMatrix

Create one hot matrix for a given label
CalcDispersion

Calculate dispersion of features
DimPlot

Dimensional reduction plot
DoHeatmap

Feature expression heatmap
DotPlot

Dot plot visualization
FetchResiduals_reference

temporal function to get residuals from reference
CellScatter

Cell-cell scatter plot
BridgeReferenceSet-class

The BridgeReferenceSet Class The BridgeReferenceSet is an output from PrepareBridgeReference
CellSelector

Cell Selector
FilterSlideSeq

Filter stray beads from Slide-seq puck
CalcPerturbSig

Calculate a perturbation Signature
CalculateBarcodeInflections

Calculate the Barcode Distribution Inflection
FindBridgeIntegrationAnchors

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

Move outliers towards center on dimension reduction plot
ColorDimSplit

Color dimensional reduction plot by tree split
CreateSCTAssayObject

Create a SCT Assay object
BGTextColor

Determine text color based on background color
CollapseSpeciesExpressionMatrix

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

Plot the Barcode Distribution and Calculated Inflection Points
FindBridgeTransferAnchors

Find bridge anchors between query and extended bridge-reference
DISP

Find variable features based on dispersion
Cells.SCTModel

Get Cell Names
FindTransferAnchors

Find transfer anchors
FindIntegrationAnchors

Find integration anchors
CombinePlots

Combine ggplot2-based plots into a single plot
CellsByImage

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

Gene expression markers of identity classes
DietSeurat

Slim down a Seurat object
FastRPCAIntegration

Perform integration on the joint PCA cell embeddings.
GetIntegrationData

Get integration data
BlackAndWhite

Create a custom color palette
FindVariableFeatures

Find variable features
Graph-class

The Graph Class
GroupCorrelation

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

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

Calculate the standard deviation of logged values
CustomDistance

Run a custom distance function on an input data matrix
FastRowScale

Scale and/or center matrix rowwise
DimReduc-class

The DimReduc Class
ExpVar

Calculate the variance of logged values
FindAllMarkers

Gene expression markers for all identity classes
HTOHeatmap

Hashtag oligo heatmap
IntegrateEmbeddings

Integrate low dimensional embeddings
FeaturePlot

Visualize 'features' on a dimensional reduction plot
DiscretePalette

Discrete colour palettes from pals
FindBridgeAnchor

Find bridge anchors between two unimodal datasets
IntegrateLayers

Integrate Layers
DEenrichRPlot

DE and EnrichR pathway visualization barplot
ElbowPlot

Quickly Pick Relevant Dimensions
FindMultiModalNeighbors

Construct weighted nearest neighbor graph
HVFInfo.SCTAssay

Get Variable Feature Information
FindClusters

Cluster Determination
FeatureScatter

Scatter plot of single cell data
FindConservedMarkers

Finds markers that are conserved between the groups
NormalizeData

Normalize Data
PolyDimPlot

Polygon DimPlot
PolyFeaturePlot

Polygon FeaturePlot
ReadVitessce

Read Data From Vitessce
PCASigGenes

Significant genes from a PCA
IntegrationAnchorSet-class

The IntegrationAnchorSet Class
MapQuery

Map query cells to a reference
MVP

Find variable features based on mean.var.plot
ProjectDimReduc

Project query data to reference dimensional reduction
ProjectIntegration

Integrate embeddings from the integrated sketched.assay
ReadVizgen

Read and Load MERFISH Input from Vizgen
HarmonyIntegration

Harmony Integration
RunPCA

Run Principal Component Analysis
ExpMean

Calculate the mean of logged values
HoverLocator

Hover Locator
IntegrationData-class

The IntegrationData Class
Load10X_Spatial

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

Load the Annoy index file
FindNeighbors

(Shared) Nearest-neighbor graph construction
JackStraw

Determine statistical significance of PCA scores.
FetchResidualSCTModel

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

Fold Change
PrepLDA

Function to prepare data for Linear Discriminant Analysis.
NNPlot

Highlight Neighbors in DimPlot
LogNormalize

Normalize Raw Data
RunSLSI

Run Supervised Latent Semantic Indexing
GetTransferPredictions

Get the predicted identity
GetTissueCoordinates.SlideSeq

Get Tissue Coordinates
ModalityWeights-class

The ModalityWeights Class
PredictAssay

Predict value from nearest neighbors
LocalStruct

Calculate the local structure preservation metric
FetchResiduals

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

Scale and center the data.
SaveAnnoyIndex

Save the Annoy index
GaussianSketch

Gaussian sketching
ISpatialFeaturePlot

Visualize features spatially and interactively
RunGraphLaplacian

Run Graph Laplacian Eigendecomposition
ReadNanostring

Read and Load Nanostring SMI data
ReadParseBio

Read output from Parse Biosciences
SingleImageMap

SingleImagePlot

Single Spatial Plot
SingleRasterMap

A single heatmap from ggplot2 using geom_raster
ImageDimPlot

Spatial Cluster Plots
SingleSpatialPlot

Base plotting function for all Spatial plots
LabelPoints

Add text labels to a ggplot2 plot
LabelClusters

Label clusters on a ggplot2-based scatter plot
MetaFeature

Aggregate expression of multiple features into a single feature
JackStrawData-class

The JackStrawData Class
NNtoGraph

Convert Neighbor class to an asymmetrical Graph class
MappingScore

Metric for evaluating mapping success
Neighbor-class

The Neighbor Class
UpdateSCTAssays

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

Transfer embeddings from sketched cells to the full data
FindSpatiallyVariableFeatures

Find spatially variable features
GroupCorrelationPlot

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

Run Independent Component Analysis on gene expression
RunMixscape

Run Mixscape
RunMoransI

Compute Moran's I value.
ImageFeaturePlot

Spatial Feature Plots
LoadCurioSeeker

Load Curio Seeker data
IntegrateData

Integrate data
PlotClusterTree

Plot clusters as a tree
FindSubCluster

Find subclusters under one cluster
GetAssay

Get an Assay object from a given Seurat object.
IFeaturePlot

Visualize features in dimensional reduction space interactively
ISpatialDimPlot

Visualize clusters spatially and interactively
JointPCAIntegration

Seurat-Joint PCA Integration
GetImage.SlideSeq

Get Image Data
JackStrawPlot

JackStraw Plot
PlotPerturbScore

Function to plot perturbation score distributions.
LoadSTARmap

Load STARmap data
SelectSCTIntegrationFeatures

Select SCT integration features
L2CCA

L2-Normalize CCA
SetIntegrationData

Set integration data
Seurat-package

Seurat: Tools for Single Cell Genomics
PrepareBridgeReference

Prepare the bridge and reference datasets
LeverageScore

Leverage Score Calculation
LogVMR

Calculate the variance to mean ratio of logged values
LinkedPlots

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

Load in data from 10X
HTODemux

Demultiplex samples based on data from cell 'hashing'
MULTIseqDemux

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

Project query data to the reference dimensional reduction
ProjectUMAP

Project query into UMAP coordinates of a reference
Read10X_Image

Load a 10X Genomics Visium Image
MixscapeHeatmap

Differential expression heatmap for mixscape
PrepSCTFindMarkers

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

Linear discriminant analysis on pooled CRISPR screen data.
Read10X_h5

Read 10X hdf5 file
L2Dim

L2-normalization
MinMax

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

Prepare an object list normalized with sctransform for integration.
MixingMetric

Calculates a mixing metric
Read10X_probe_metadata

Read10x Probe Metadata
RunTSNE

Run t-distributed Stochastic Neighbor Embedding
RenameCells.SCTAssay

Rename Cells in an Object
RelativeCounts

Normalize raw data to fractions
SingleExIPlot

Plot a single expression by identity on a plot
RunSPCA

Run Supervised Principal Component Analysis
SplitObject

Splits object into a list of subsetted objects.
PercentAbove

Calculate the percentage of a vector above some threshold
SingleDimPlot

Plot a single dimension
RPCAIntegration

Seurat-RPCA Integration
Radius.SlideSeq

Get Spot Radius
RunLDA

Run Linear Discriminant Analysis
PseudobulkExpression

Pseudobulk Expression
SubsetByBarcodeInflections

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

Read output from STARsolo
ReadMtx

Load in data from remote or local mtx files
ProjectData

Project full data to the sketch assay
PercentageFeatureSet

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

Project Dimensional reduction onto full dataset
ReadAkoya

Read and Load Akoya CODEX data
RunMarkVario

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

The SeuratCommand Class
TopNeighbors

Get nearest neighbors for given cell
ReadSlideSeq

Load Slide-seq spatial data
SelectIntegrationFeatures

Select integration features
LoadXenium

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

Regroup idents based on meta.data info
SpatialImage-class

The SpatialImage Class
TransferAnchorSet-class

The TransferAnchorSet Class
SpatialPlot

Visualize spatial clustering and expression data.
UpdateSymbolList

Get updated synonyms for gene symbols
SelectIntegrationFeatures5

Select integration features
SeuratTheme

Seurat Themes
VisiumV1-class

The VisiumV1 class
SingleCorPlot

A single correlation plot
VariableFeaturePlot

View variable features
VizDimLoadings

Visualize Dimensional Reduction genes
RunUMAP

Run UMAP
SCTransform

Perform sctransform-based normalization
RidgePlot

Single cell ridge plot
RunCCA

Perform Canonical Correlation Analysis
SCTResults

Get SCT results from an Assay
cc.genes

Cell cycle genes
VST

Variance Stabilizing Transformation
as.SingleCellExperiment

Convert objects to SingleCellExperiment objects
ScaleFactors

Get image scale factors
VlnPlot

Single cell violin plot
ScoreJackStraw

Compute Jackstraw scores significance.
TopCells

Find cells with highest scores for a given dimensional reduction technique
as.CellDataSet

Convert objects to CellDataSet objects
Seurat-class

The Seurat Class
SetQuantile

Find the Quantile of Data
TopFeatures

Find features with highest scores for a given dimensional reduction technique
cc.genes.updated.2019

Cell cycle genes: 2019 update
as.sparse.H5Group

Cast to Sparse
merge.SCTAssay

Merge SCTAssay objects
components

Objects exported from other packages
SCTAssay-class

The SCTModel Class
as.Seurat.CellDataSet

Convert objects to Seurat objects
contrast-theory

Get the intensity and/or luminance of a color
STARmap-class

The STARmap class
SampleUMI

Sample UMI
TransferData

Transfer data
TransferSketchLabels

Transfer data from sketch data to full data
SketchData

Sketch Data
SlideSeq-class

The SlideSeq class
fortify-Spatial

Prepare Coordinates for Spatial Plots
subset.AnchorSet

Subset an AnchorSet object
writing-integration

Writing Integration Method Functions
AddAzimuthResults

Add Azimuth Results