SeuratObject (version 5.0.1)

HVFInfo: Highly Variable Features

Description

Get and set variable feature information for an Assay object. HVFInfo and VariableFeatures utilize generally variable features, while SVFInfo and SpatiallyVariableFeatures are restricted to spatially variable features

Usage

HVFInfo(object, method, status = FALSE, ...)
VariableFeatures(object, method = NULL, ...)
VariableFeatures(object, ...) <- value
SVFInfo(object, method, status, ...)
SpatiallyVariableFeatures(object, method, ...)
# S3 method for Seurat
HVFInfo(
  object,
  method = NULL,
  status = FALSE,
  assay = NULL,
  selection.method = deprecated(),
  ...
)
# S3 method for Seurat
VariableFeatures(
  object,
  method = NULL,
  assay = NULL,
  nfeatures = NULL,
  layer = NA,
  simplify = TRUE,
  selection.method = deprecated(),
  ...
)
# S3 method for Seurat
VariableFeatures(object, assay = NULL, ...) <- value
# S3 method for Seurat
SVFInfo(
  object,
  method = c("markvariogram", "moransi"),
  status = FALSE,
  assay = NULL,
  selection.method = deprecated(),
  ...
)
# S3 method for Seurat
SpatiallyVariableFeatures(
  object,
  method = "moransi",
  assay = NULL,
  decreasing = TRUE,
  selection.method = deprecated(),
  ...
)
# S3 method for Assay
HVFInfo(object, method, status = FALSE, selection.method = deprecated(), ...)
# S3 method for Assay
SpatiallyVariableFeatures(
  object,
  method = "moransi",
  decreasing = TRUE,
  selection.method = deprecated(),
  ...
)
# S3 method for Assay
SVFInfo(
  object,
  method = c("markvariogram", "moransi"),
  status = FALSE,
  selection.method = deprecated(),
  ...
)
# S3 method for Assay
VariableFeatures(object, method = NULL, selection.method = deprecated(), ...)
# S3 method for Assay
VariableFeatures(object, ...) <- value
# S3 method for Assay5
HVFInfo(object, method = NULL, status = FALSE, layer = NULL, strip = TRUE, ...)
# S3 method for Assay5
VariableFeatures(
  object,
  method = NULL,
  layer = NA,
  simplify = TRUE,
  nfeatures = Inf,
  selection.method = deprecated(),
  ...
)
# S3 method for Assay5
VariableFeatures(object, method = "custom", layer = NULL, ...) <- value

Value

HVFInfo: A data frame with feature means, dispersion, and scaled dispersion

VariableFeatures: a vector of the variable features

SVFInfo: a data frame with the spatially variable features

SpatiallyVariableFeatures: a character vector of the spatially variable features

Arguments

object

An object

method

Which method to pull. For HVFInfo and VariableFeatures, choose one from one of the following:

• “vst”

• “sctransform” or “sct”

• “mean.var.plot”, “dispersion”, “mvp”, or “disp”

For SVFInfo and SpatiallyVariableFeatures, choose from:

• “markvariogram”

• “moransi”

status

Add variable status to the resulting data frame

...

Arguments passed to other methods

value

A character vector of variable features

assay

Name of assay to pull highly variable feature information for

selection.method

lifecycle::badge("deprecated")

nfeatures

Maximum number of features to select when simplifying

layer

Layer to pull variable features for

simplify

When pulling for multiple layers, combine into a single vector and select a common set of variable features for all layers

decreasing

Return features in decreasing order (most spatially variable first).

strip

Remove method/layer identifiers from highly variable data frame

Examples

# Get the HVF info from a specific Assay in a Seurat object
HVFInfo(object = pbmc_small, assay = "RNA")[1:5, ]

# Get the HVF info directly from an Assay object
HVFInfo(pbmc_small[["RNA"]], method = 'vst')[1:5, ]