ExportSeurat: Export a Seurat object in BCS format

In bioturing/rBCS: Handle BioTuring Compressed File

Export a Seurat object in BCS format

Description

Export a Seurat object in BCS format

Usage

ExportSeurat(
  object,
  bcs.path,
  unique.limit = 100,
  sort = FALSE,
  batch.name = "bioturing_batch",
  compression.level = 1,
  author = "rBCS",
  raw.rna = "RNA",
  norm.rna = "RNA",
  raw.adt = "ADT",
  norm.adt = "ADT",
  overwrite = FALSE
)

Arguments

object	a Seurat object
bcs.path	path to BCS file
unique.limit	ignore a metadata if it has number of unique labels larger than this number. Default is 100.
sort	if TRUE, metadata with be sorted based on cell count (descending order). Default is FALSE
batch.name	name of the metadata of batches. This is for specialized functions in BBrowser that requires batch's information.
compression.level	an integer ranging from 1 to 9. Higher level creates smaller files but takes more time to create and load. Default is 1.
author	email of the creator. Default is rBCS.
raw.rna	name of the assay that has mRNA raw count. Default is RNA.
norm.rna	name of the assay that has mRNA normalized count. Default is RNA.
raw.adt	name of the assay that has ADT raw count. Default is ADT.
norm.adt	name of the assay that has ADT normalized count. Default is ADT.
overwrite	if TRUE, overwrite existing file at bcs.path. Default is FALSE.

bioturing/rBCS documentation built on May 18, 2022, 5:26 p.m.