SeuratObject (version 5.0.2)

Tool: Get and Set Additional Tool Data

Description

Use Tool to get tool data. If no additional arguments are provided, will return a vector with the names of tools in the object.

Usage

Tool(object, ...)
Tool(object, ...) <- value
# S3 method for Seurat
Tool(object, slot = NULL, ...)
# S3 method for Seurat
Tool(object, ...) <- value

Value

If no additional arguments, returns the names of the tools in the object; otherwise returns the data placed by the tool requested

Arguments

object

An object

...

Arguments passed to other methods

value

Information to be added to tool list

slot

Name of tool to pull

Examples

# Example function that adds unstructured data to tools
MyTool <- function(object) {
  sample.tool.output <- matrix(rnorm(n = 16), nrow = 4)
  # Note: `Tool<-` must be called from within a function
  # and the name of the tool will be generated from the function name
  Tool(object) <- sample.tool.output
  return(object)
}

# Run our tool
set.seed(42L)
pbmc_small <- MyTool(pbmc_small)

# Get a list of tools run
Tool(pbmc_small)

# Access specific tool data
Tool(pbmc_small, slot = "MyTool")