snapatac2.read_dataset#

snapatac2.read_dataset(filename, *, update_data_locations=None, mode='r+', backend=None)#

Read AnnDataSet object.

Read AnnDataSet from .h5ads file. If the file paths stored in AnnDataSet object are relative paths, it will look for component .h5ad files in .h5ads file’s parent directory.

Parameters:

  • filename (Path) – File name.

  • update_data_locations (Mapping[str, str]) – If provided, locations of component anndata files will be updated.

  • mode (str) – “r”: Read-only mode; “r+”: can modify annotation file but not component anndata files.

  • backend (Literal['hdf5'] | None) –

Return type:

AnnDataSet