copyCompleteToolsSlots: Copy Tools Slots from Multiple Seurat Objects

View source: R/Seurat.Utils.R

copyCompleteToolsSlotsR Documentation

Copy Tools Slots from Multiple Seurat Objects

Description

This function copies the ⁠@tools⁠ slots from a list of Seurat objects into a new slot of a target Seurat object. This allows for the aggregation of tools information from multiple experiments or datasets into a single, consolidated Seurat object.

Usage

copyCompleteToolsSlots(
  ls.obj,
  obj.to,
  overwrite = TRUE,
  new.slot = "per.experiment"
)

Arguments

ls.obj

A list of Seurat objects from which the ⁠@tools⁠ slots will be copied.

obj.to

The target Seurat object to which the ⁠@tools⁠ slots will be added.

overwrite

A logical parameter that is kept for compatibility but not used in this version. Its presence does not affect the function's behavior.

new.slot

The name of the new slot within obj.to@tools where the copied ⁠@tools⁠ information will be stored. This allows for the organization of copied tools under a specific label, facilitating easy access and interpretation.

Value

Returns the modified target Seurat object (obj.to) with a new ⁠@tools⁠ slot containing the copied information from the list of Seurat objects.

Examples

# Assuming `ls.obj` is a list of Seurat objects and `obj.to` is a target Seurat object
obj.to <- copyCompleteToolsSlots(ls.obj, obj.to, overwrite = TRUE, new.slot = "per.experiment")

vertesy/Seurat.utils documentation built on Dec. 4, 2024, 5:20 p.m.