addToMiscOrToolsSlot: Add to Misc or Tools Slot

View source: R/Seurat.Utils.R

addToMiscOrToolsSlotR Documentation

Add to Misc or Tools Slot

Description

This function creates and adds a sub-slot to either the 'misc' or 'tools' slot of a Seurat object. If the sub-slot already exists, it can either be overwritten or a warning will be issued.

Usage

addToMiscOrToolsSlot(
  obj,
  pocket_name = "misc",
  slot_value = NULL,
  slot_name = substitute_deparse(slot_value),
  sub_slot_value = NULL,
  sub_slot_name = substitute_deparse(sub_slot_value),
  overwrite = FALSE
)

Arguments

obj

A Seurat object.

pocket_name

Which main pocket to use: 'misc' or 'tools'. Default: 'misc'.

slot_value

The value to be assigned to the sub-slot.

slot_name

The name of the sub-slot. Automatically derived from 'sub_slot_value' if not provided.

sub_slot_value

The value to be assigned to the sub-slot.

sub_slot_name

The name of the sub-slot. Automatically derived from 'sub_slot_value' if not provided.

overwrite

A boolean indicating whether to overwrite an existing sub-slot with the same name.

Value

The modified Seurat object with the new or updated sub-slot.


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