FACSPy.save_dataset

Contents

FACSPy.save_dataset#

FACSPy.save_dataset(adata, output_dir=None, file_name=None, overwrite=False, **kwargs)#

Saves the dataset as an .h5ad file. Because we are storing custom objects in adata.uns, the function saves the .uns metadata separately and reads it back upon import.

Parameters:

  • adata (AnnData) – The anndata object to save.

  • output_dir (Optional[PathLike]) – Deprecated in favor of a PathLike file_name.

  • file_name (Optional[PathLike]) – Path to save to.

  • overwrite (bool) – If set to True, the function will overwrite the file that has the same filename

  • **kwargs – Keyword arguments passed to the AnnData.write() method. Please refer to their documentation.

Return type:

None

Examples

>>> import FACSPy as fp
>>> dataset = fp.create_dataset(...)
>>> fp.save_dataset(dataset, "raw_dataset.h5ad", overwrite = True)
Contents