compressSerHD5: compressSerHD5

View source: R/Seurat_based.R

compressSerHD5R Documentation

compressSerHD5

Description

compressSerHD5 will save space on your drives.

Usage

compressSerHD5(
  SerObj = NULL,
  load.path = NULL,
  overwrite = F,
  save.path = NULL,
  updateSerObj = F,
  returnSerObj = F
)

Arguments

SerObj

A Seurat Object

load.path

the path to a seurat .rds file

overwrite

default F overwirtes the new hd5 if exists

save.path

the path to the desired hd5 seurat file. Default is NULL which then load.path is used to save the new object next to it.

updateSerObj

default F if T runs UpdateSerObj()

returnSerObj

default F if T returns the Seurat object to be used in a pipeline

Value

Saves HD5 Seurat object to path given


eisascience/scCustFx documentation built on June 2, 2025, 3:59 a.m.