writeSCESet: Write an SCESet object to an HDF5 file

In dynverse/scaterlegacy: Single-cell analysis toolkit for gene expression data in R

Description

Write an SCESet object to an HDF5 file

Usage

writeSCESet(object, file_path, type = "HDF5", overwrite_existing = FALSE)

Arguments

object	SCESet object to be writted to file
file_path	path to written file containing data from SCESet object
type	character string indicating type of output file. Default is "HDF5".
overwrite_existing	logical, if a file of the same name already exists should it be overwritten? Default is FALSE.

Details

Currently writing to HDF5 files is supported. The rhdf5 package is used to write data to file and can be used to read data from HDF5 files into R. For further details about the HDF5 data format see https://support.hdfgroup.org/HDF5/.

Value

Return is NULL, having written the SCESet object to file.

Examples

data("sc_example_counts")
data("sc_example_cell_info")
pd <- new("AnnotatedDataFrame", data = sc_example_cell_info)
example_sceset <- newSCESet(countData = sc_example_counts, phenoData = pd)

## Not run: 
writeSCESet(example_sceset, "test.h5")
file.remove("test.h5")

## End(Not run)

dynverse/scaterlegacy documentation built on Feb. 17, 2020, 5:07 a.m.