cellxgene_census.download_source_h5ad

cellxgene_census.download_source_h5ad(dataset_id: str, to_path: str, *, census_version: str = 'stable', progress_bar: bool = True) → None

Download the source H5AD dataset, for the given dataset_id, to the user-specified file name.

Parameters:

dataset_id – Fetch the source (original) H5AD associated with this dataset_id.
to_path – The file name where the downloaded H5AD will be written. Must not already exist.
census_version – The census version name. Defaults to "stable".
progress_bar – Whether to display a progress bar. Defaults to True.

Raises:

ValueError – if the path already exists (i.e., will not overwrite an existing file), or is not a file.

Lifecycle

maturing