Skip to contents

Setter functions take the object as the first argument and a new value as the second. These functions allow a user to directly modify an object's data slot. Each method implements checks on the validity of the object after the data slot is modified. Use caution when applying Setters, since they modify the objects in place, and cannot be undone.

Usage

projectMetadata(x) <- value

# S4 method for SpatialMap
projectMetadata(x) <- value

featureInfo(x) <- value

# S4 method for Region
featureInfo(x) <- value

features(x) <- value

# S4 method for Region
features(x) <- value

# S4 method for Analysis
features(x) <- value

# S4 method for list
features(x) <- value

# S4 method for list
features(x) <- value

# S4 method for SpatialMap
features(x) <- value

cells(x) <- value

# S4 method for Region,list
cells(x) <- value

# S4 method for Region,character
cells(x) <- value

# S4 method for Analysis,list
cells(x) <- value

channelInfo(x) <- value

# S4 method for Region
channelInfo(x) <- value

bgData(x) <- value

# S4 method for Region
bgData(x) <- value

bgFeatures(x) <- value

# S4 method for Region
bgFeatures(x) <- value

Arguments

x

A SpatialMap or Region object

value

If applicable, a character string specifying which named item

Details

Setter functions are supplemented by helper functions, such as addCellMetadata and updateRegionData, that provide a high-level API into the S4 objects, with more comprehensive validity checks, error messages, and a smoother, more flexible user interface.

Getter methods correspond to data slots in the S4 objects:

  • projectMetadata<- (SpatialMap)

  • cells<-

  • features<-

  • activeRegions<- (SpatialMap)

  • activeAnalysis<- (SpatialMap)

  • cellMetadata<-

  • featureInfo<-

  • bgData<-

Scroll to top