Learn R Programming

⚠️There's a newer version (5.2.0) of this package.Take me there.

SeuratObject (version 5.0.1)

Data Structures for Single Cell Data

Description

Defines S4 classes for single-cell genomic data and associated information, such as dimensionality reduction embeddings, nearest-neighbor graphs, and spatially-resolved coordinates. Provides data access methods and R-native hooks to ensure the Seurat object is familiar to other R users. See Satija R, Farrell J, Gennert D, et al (2015) , Macosko E, Basu A, Satija R, et al (2015) , and Stuart T, Butler A, et al (2019) , Hao Y, Hao S, et al (2021) and Hao Y, et al (2023) for more details.

Copy Link

Version

Install

install.packages('SeuratObject')

Monthly Downloads

44,052

Version

5.0.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Paul Hoffman

Last Published

November 17th, 2023

Functions in SeuratObject (5.0.1)

Centroids-class

The Centroids Class
Centroids-methods

Centroids Methods
Command

Get SeuratCommands
CheckLayersName

Check layers names for the input list
GetTissueCoordinates

Get tissue coordinates
Crop

Crop Coordinates
DefaultFOV

Get and Set the Default FOV
CreateDimReducObject

Create a DimReduc object
CreateCentroids

Create a Centroids Objects
ClassKey

Generate a Class Key
DefaultLayer-StdAssay

Default Layer
DimReduc-validity

Dimensional Reduction Validity
DefaultAssay-StdAssay

Default Assay
GetImage

Get image data
Cells-StdAssay

Cell and Feature Names
CastAssay

Cast Assay Layers
CreateAssay5Object

Create a v5 Assay object
Overlay

Overlay Spatial Objects Over One Another
Embeddings

Get Cell Embeddings
CreateFOV

Create Spatial Coordinates
CreateAssayObject

Create an Assay object
FOV-class

The Field of View Object
IsGlobal

Is an object global/persistent?
Segmentation-class

The Segmentation Class
ExtractField

Extract delimiter information from a string.
IsMatrixEmpty

Check if a matrix is empty
CheckDots

Check the Use of Dots
IsSparse

Is a Matrix Sparse
CheckMatrix

Check Matrix Validity
Graph-class

The Graph Class
DefaultLayer

Default Layer
JackStrawData-class

The JackStrawData Class
Loadings

Get and set feature loadings
JS

Get and set JackStraw information
Images

Pull spatial image names
CellsByIdentities

Get cell names grouped by identity class
CheckFeaturesNames

Check features names format
Cells

Cell and Feature Names
PackageCheck

Check the existence of a package
LogMap

A Logical Map
CheckGC

Conditional Garbage Collection
StitchMatrix

Stitch Matrices Together
SaveSeuratRds

Save and Load Seurat Objects from Rds files
PolyVtx

Polygon Vertices
LogSeuratCommand

Log a command
EmptyDF

Empty Data Frames
Angles

Radian/Degree Conversions
CreateMolecules

Create a Molecules Object
DimReduc-class

The Dimensional Reduction Class
RenameAssays

Rename assays in a Seurat object
Idents

Get, set, and manipulate an object's identity classes
Seurat-validity

Seurat Object Validity
FOV-validity

FOV Validity
dimnames.Assay5

Assay-Level Feature and Cell Names
Key

Get and set object keys
CreateSegmentation

Create a Segmentation Objects
RegisterSparseMatrix

Register Sparse Matrix Classes
LayerData

Query and Manipulate Assay Layers
FOV-methods

FOV Methods
CreateSeuratObject

Create a Seurat object
Indices

Get Neighbor nearest neighbor index matrices
Layers-StdAssay

Query and Manipulate Assay Layers
Misc

Get and set miscellaneous data
StdAssay-class

Core Assay Infrastructure
MatchCells

Match Cells
Misc-StdAssay

Get and set miscellaneous data
KeyMixin-class

A Mixin for Keyed objects
LogMap-validity

Logical Map Validity
FetchData

Access cellular data
JoinLayers

Split and Join Layers Together
Theta

Get the offset angle
dim.StdAssay

Feature and Cell Numbers
DefaultAssay

Default Assay
DefaultDimReduc

Find the default DimReduc
Segmentation-methods

Segmentation Methods
.Subobjects

Get the Subobject Names
Assays

Query Specific Object Types
RenameCells-StdAssay

Rename cells
Neighbor-methods

Neighbor Methods
Key-validity

Key Validity
Simplify

Simplify Geometry
FilterObjects

Find Sub-objects of a Certain Class
Distances

Get the Neighbor nearest neighbors distance matrix
Stdev

Get the standard deviations for an object
.DollarNames.SeuratCommand

Dollar-sign Autocompletion
s4list

S4/List Conversion
Tool

Get and Set Additional Tool Data
SeuratCommand-class

The SeuratCommand Class
dim.DimReduc

Dimensional Reduction Meta-Information
SparseEmptyMatrix

Generate empty dgC sparse matrix
Index

Get Neighbor algorithm index
Molecules-class

The Spatial Molecules Class
RandomName

Generate a random name
Neighbor-class

The Neighbor class
JackStrawData-methods

JackStrawData Methods
as.matrix.LogMap

Coerce Logical Maps to Matrices
as.Centroids

Convert Segmentation Layers
WhichCells

Identify cells matching certain criteria
SeuratObject-options

Seurat Options
[.Assay

Layer Data
IsNamedList

Check List Names
SeuratObject-package

SeuratObject: Data Structures for Single Cell Data
as.sparse

Cast to Sparse
aggregate

Aggregate Molecules into an Expression Matrix
[[.Assay5

Feature-Level Meta Data
dimnames.Assay

Assay-Level Feature and Cell Names
$.Assay5

Layer Data
UpdateSeuratObject

Update old Seurat object to accommodate new features
as.Graph

Coerce to a Graph Object
.FilterObjects

Find Subobjects Of A Certain Class
.AssayClass

Assay Class Label
$.StdAssay

Layer Data
HVFInfo

Highly Variable Features
Version

Get Version Information
.Contains

Get Parent S4 Classes
[.StdAssay

Layer Data
droplevels.LogMap

Drop Unused Logical Map Values
v5-assay-summaries

V5 Assay Summaries
.FindObject

Find A Subobject
as.Neighbor

Coerce to a Neighbor Object
dim.Seurat

Feature and Cell Numbers
.SelectFeatures

Combine and Select Features
dim.Assay5

Feature and Cell Numbers
.DiskLoad

Disk Loading Function
Project

Get and set project information
Molecules-methods

Molecules Methods
[[<-,Seurat,character,missing,StdAssay-method

Add Subobjects
SpatialImage-methods

SpatialImage methods
UpdateSlots

Update slots in an object
$.Assay

Layer Data
dimnames.StdAssay

Assay-Level Feature and Cell Names
split.Assay

Split an Assay
split.Assay5

Split an Assay
[[.Assay

Feature-Level Meta Data
.CalcN

Calculate nCount and nFeature
[[,LogMap,integer,missing-method

LogMap Interaction Methods
Radius

Get the spot radius from an image
StdAssay-validity

V5 Assay Validity
[[.StdAssay

Feature-Level Meta Data
Seurat-class

The Seurat Class
.Collections

Identify Object Collections
.BPMatrixMode

BPCells Matrix Mode
.GetMethod

Get a Method
reexports

Objects exported from other packages
.IsFutureSeurat

Test Future Compatibility with Seurat
.DollarNames.Assay

Dollar-sign Autocompletion
RenameCells

Rename cells
colMeans,Assay-method

Row and Column Sums and Means
dimnames.Seurat

Feature and Cell Names
.CheckFmargin

Check Feature Margin
RowMergeSparseMatrices

Merge Sparse Matrices by Row
.CreateStdAssay

Generic Assay Creation
subset.Assay

Subset an Assay
.SparseSlots

Identify Sparse Slots
SpatialImage-class

The SpatialImage class
$.SeuratCommand

Command Log Parameter Access
as.Seurat

Coerce to a Seurat Object
$.Seurat

Cell-Level Meta Data
VariableFeatures-StdAssay

Highly Variable Features
labels.LogMap

Find Observations by Value
[[<-,Seurat

Add Subobjects
[,LogMap

Matrix-like Subsetting for Logical Maps
intersect.LogMap

Find Common Logical Map Values
set-if-na

Set If or If Not NA
.DollarNames.Assay5

Dollar-sign Autocompletion
.DollarNames.StdAssay

Dollar-sign Autocompletion
show,Graph-method

Graph Object Overview
.MARGIN

Get the Margin of an Object
.PropagateList

Propagate a List
as.list.SeuratCommand

Coerce a SeuratCommand to a list
.RandomKey

Generate a Random Key
.ClassPkg

Get the Package that Defines a Class
dim.Assay

Feature and Cell Numbers
show,LogMap-method

LogMap Object Overview
colMeans,Seurat-method

Row and Column Sums and Means
old-assign

Original double-bracket assign
merge.Assay

Merge Assays
seurat-class

The Seurat Class
show,Assay-method

V3 Assay Overview
pbmc_small

A small example version of the PBMC dataset
.DollarNames.Seurat

Dollar-sign Autocompletion
.KeyPattern

Regex Pattern for Keys
.DefaultFOV

Find the Default FOV
show,seurat-method

Old Seurat Object Overview
merge.Assay5

Merge Assays
[[<-,Seurat,NULL

Remove Subobjects and Cell-Level Meta Data
show,StdAssay-method

V5 Assay Overview
set-if-null

Set If or If Not NULL
[.DimReduc

Get Feature Loadings
[.SeuratCommand

Command Log Data Access
print.DimReduc

Print Top Feature Loadings
split.Seurat

Split an Assay
show,DimReduc-method

Dimensional Reduction Overview
split.StdAssay

Split an Assay
names.Seurat

Subobject Names
merge.DimReduc

Merge Dimensional Reductions
.Deprecate

Deprecate Functions and Arguments
[[.DimReduc

Get Cell Embeddings
merge.Seurat

Merge Seurat Objects
.FilePath

Find a File Path
.FileMove

Move Files and Directories
show,SeuratCommand-method

Command Log Overview
[.Assay5

Layer Data
[[.Seurat

Subobjects and Cell-Level Meta Data
show,Seurat-method

Seurat Object Overview
subset.Seurat

Subset Seurat Objects
subset.Assay5

Subset an Assay
subset.DimReduc

Subset a Dimensional Reduction
subset.StdAssay

Subset an Assay
merge.StdAssay

Merge Assays
AssayData

Get and Set Assay Data
AddMetaData-StdAssay

Add in metadata associated with either cells or features.
Assay5-class

The v5 Assay Object
AttachDeps

Attach Required Packages
AddMetaData

Add in metadata associated with either cells or features.
Assay-class

The Assay Class
Assay5-validity

V5 Assay Validity
Assay-validity

V3 Assay Validity
Boundaries

Get, Set, and Query Segmentation Boundaries
CellsByImage

Get a vector of cell names associated with an image (or set of images)
AssayData-StdAssay

Get and Set Assay Data
Assay5T-class

The Transposed v5 Assay Object
CastAssay-StdAssay

Cast Assay Layers