scConvGDS {SCArray}R Documentation

Create a GDS file

Description

Creates a single-cell GDS file from an R object.

Usage

scConvGDS(obj, outfn, save.sp=TRUE, type=c("float32", "float64", "int32"),
    compress="LZMA_RA", clean=TRUE, verbose=TRUE)

Arguments

obj

a dense/sparse matrix, DelayedMatrix, SummarizedExperiment or SingleCellExperiment

outfn

the output file name in GDS format

save.sp

if TRUE, save it to a sparse matrix in GDS; otherwise, store dense matrix

type

numeric data type in the output file

compress

the compression method, see add.gdsn

clean

TRUE

verbose

if TRUE, show information

Value

Return the path of the output file.

Author(s)

Xiuwen Zheng

See Also

scOpen, scClose

Examples

# load a SingleCellExperiment object
fn <- system.file("extdata", "LaMannoBrainSub.rds", package="SCArray")
sce <- readRDS(fn)

scConvGDS(sce, "test.gds")

# remove the temporary output file
unlink("test.gds")

[Package SCArray version 1.2.1 Index]