Read data from a H5AD file
Arguments
- path
Path to the H5AD file to read
- as
The type of object to return. One of:
"InMemoryAnnData": Read the H5AD file into memory as anInMemoryAnnDataobject"HDF5AnnData": Read the H5AD file as anHDF5AnnDataobject"SingleCellExperiment": Read the H5AD file as aSingleCellExperiment::SingleCellExperimentobject"Seurat": Read the H5AD file as aSeuratObject::Seuratobject
- mode
The mode to open the HDF5 file. When
groupis not"/", these apply to the groupgrouprather than the whole file:acreates a new file or opens an existing one for read/write. The group atgroupis created if it doesn't exist yet.ropens an existing file for reading, the groupgroupmust already exist.r+opens an existing file for read/write, the groupgroupmust already exist.wcreates a file, truncating any existing ones. Whengroup != "/", the file is created if missing but otherwise left untouched, and only the groupgroupis deleted and recreated. HDF5 doesn't free the space used by the deleted group, see the "File size" section ofwrite_h5ad().w-/xare synonyms, creating a file and failing if it already exists. Whengroup != "/", they instead fail if the groupgroupalready exists.
- backed
Whether to read the H5AD file in backed mode, returning an object containing DelayedArray::DelayedMatrix matrices. Which slots are backed depends on the value of
as.- group
The path to the group within the HDF5 file that the
AnnDatais stored at. Defaults to"/", the file root. Can be used to read anAnnDatafrom a group inside a file that also contains other content, e.g. a modality inside a.h5mufile.- ...
Extra arguments provided to the
as_*conversion function for the object specified byas
See also
Other AnnData creators:
AnnData(),
as_AnnData(),
read_zarr()
Examples
h5ad_file <- system.file("extdata", "example.h5ad", package = "anndataR")
# Read the H5AD as a SingleCellExperiment object
if (requireNamespace("SingleCellExperiment", quietly = TRUE)) {
sce <- read_h5ad(h5ad_file, as = "SingleCellExperiment")
}
# Read the H5AD as a Seurat object
if (requireNamespace("SeuratObject", quietly = TRUE)) {
seurat <- read_h5ad(h5ad_file, as = "Seurat")
}