exportSCEtoFlatFile: Export a SingleCellExperiment object to flat text files

View source: R/exportSCEtoTXT.R

exportSCEtoFlatFileR Documentation

Export a SingleCellExperiment object to flat text files

Description

Writes all assays, colData, rowData, reducedDims, and altExps objects in a SingleCellExperiment to text files. The items in the 'metadata' slot remain stored in list and are saved in an RDS file.

Usage

exportSCEtoFlatFile(
  sce,
  outputDir = "./",
  overwrite = TRUE,
  gzipped = TRUE,
  prefix = "SCE"
)

Arguments

sce

SingleCellExperiment object to be exported.

outputDir

Name of the directory to store the exported file(s).

overwrite

Boolean. Whether to overwrite the output files. Default TRUE.

gzipped

Boolean. TRUE if the output files are to be gzip compressed. FALSE otherwise. Default TRUE.

prefix

Prefix of file names.

Value

Generates text files containing data from inSCE.

Examples

data(sce_chcl, package = "scds")
## Not run: 
exportSCEtoFlatFile(sce_chcl, "sce_chcl")

## End(Not run)

compbiomed/singleCellTK documentation built on Feb. 10, 2024, 3:32 a.m.