exportSCEtoFlatFile: Export a SingleCellExperiment object to flat text files

Description Usage Arguments Value Examples

View source: R/exportSCEtoTXT.R

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

1
2
3
4
5
6
7
exportSCEtoFlatFile(
  sce,
  outputDir = "./",
  overwrite = TRUE,
  gzipped = TRUE,
  sample = "sample"
)

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.

sample

Name of the sample. It will be used as the prefix of file names.

Value

Generates text files containing data from inSCE.

Examples

1
2
3
4
5
data(sce_chcl, package = "scds")
## Not run: 
exportSCEtoFlatFile(sce_chcl, "sce_chcl")

## End(Not run)

singleCellTK documentation built on Nov. 8, 2020, 5:21 p.m.