read

read(path, *, assay=None, layer='counts', dtype='f32', chunk_size=5000)

Read any supported dataset into memory as an AnnData object.

H5AD files are read with :func:anndata.read_h5ad directly and the other arguments are ignored. Other formats are first converted to a temporary H5AD (see :func:convert).

Parameters

Name Type Description Default
path Pathish File or directory in any format :func:convert reads. required
assay str | None Seurat assay and layer to read from Seurat input. assay=None reads "RNA" from H5Seurat and the object’s active assay from a .rds. From MuData .h5mu assay names the modality (default: the only one, else "rna"). None
layer str | None Seurat assay and layer to read from Seurat input. assay=None reads "RNA" from H5Seurat and the object’s active assay from a .rds. From MuData .h5mu assay names the modality (default: the only one, else "rna"). None
dtype str Value type of the matrix: "f32", "f64", "i32" or "u32". 'f32'
chunk_size int Cells per streamed chunk of the conversion. 5000

Returns

Name Type Description
anndata.AnnData The whole dataset, in memory.