R: Get and set additional tool data

Tool {SeuratObject} | R Documentation

## 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 class 'Seurat'
    Tool(object, slot = NULL, ...)

    ## S3 replacement method for class 'Seurat'
    Tool(object, ...) <- value

### Arguments

`object` | An object
`...` | Arguments passed to other methods
`value` | Information to be added to tool list
`slot` | Name of tool to pull

### Value

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

### Note

For developers: set tool data using `Tool<-`. `Tool<-` will automatically set the name of the tool to the function that called `Tool<-`,so each function gets one entry in the tools list and cannot overwrite another function's entry. The automatic naming will also remove any method identifiers (eg. RunPCA.Seurat will become RunPCA); please plan accordingly.

### Examples

    Tool(object = pbmc_small)

    ## Not run:
    sample.tool.output <- matrix(data = rnorm(n = 16), nrow = 4)
    # must be run from within a function
    Tool(object = pbmc_small) <- sample.tool.output

    ## End(Not run)

[Package SeuratObject version 4.1.0 Index]