exportSCE: Export data in SingleCellExperiment object

Description Usage Arguments Value Examples

View source: R/sctkQCUtils.R

Description

Export data in SingleCellExperiment object

Usage

1
2
3
4
5
6
7
exportSCE(
  inSCE,
  samplename = "sample",
  directory = "./",
  type = "Cells",
  format = c("SCE", "AnnData", "FlatFile", "HTAN")
)

Arguments

inSCE

A SingleCellExperiment object that contains the data. QC metrics are stored in colData of the singleCellExperiment object.

samplename

Sample name. This will be used as name of subdirectories and the prefix of flat file output. Default is 'sample'.

directory

Output directory. Default is './'.

type

Type of data. The type of data stored in SingleCellExperiment object. It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).

format

The format of output. It currently supports flat files, rds files and python h5 files. It can output multiple formats. Default: c("SCE", "AnnData", "FlatFile", "HTAN").

Value

Generates a file containing data from inSCE, in specified format.

Examples

1
2
3
4
5
data(scExample)
## Not run: 
exportSCE(sce, format = "SCE")

## End(Not run)

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