updateObject: Update a SpatialFeatureExperiment object

updateObjectR Documentation

Update a SpatialFeatureExperiment object

Description

Update a SpatialFeatureExperiment to the latest version of object structure. This is usually called by internal functions.

Usage

## S4 method for signature 'SpatialFeatureExperiment'
updateObject(object, ..., verbose = FALSE)

SFEVersion(object)

Arguments

object

An old SpatialFeatureExperiment object.

...

Additional arguments that are ignored.

verbose

Logical scalar indicating whether a message should be emitted as the object is updated.

Details

Version 1.1.4 adds package version to the SFE object. We are considering an overhaul of the spatialGraphs slot in a future version using the sfdep package to decouple the adjacency graph from the edge weights.

Value

An updated version of object.

See Also

objectVersion, which is used to determine if the object is up-to-date.

Examples

library(SFEData)
sfe <- McKellarMuscleData("small")
# First version of SFE object doesn't log SFE package version, so should be NULL
SFEVersion(sfe)
sfe <- updateObject(sfe)
# See current version
SFEVersion(sfe)

pachterlab/SpatialFeatureExperiment documentation built on Dec. 20, 2024, 3:41 a.m.