cellxgene_census.download_source_h5ad¶
- cellxgene_census.download_source_h5ad(dataset_id: str, to_path: str, *, census_version: str = 'stable') 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"
.
- Raises:
ValueError – if the path already exists (i.e., will not overwrite an existing file), or is not a file.
Lifecycle
maturing
See also
get_source_h5ad_uri()
: Look up the location of the source H5AD.Examples
>>> download_source_h5ad("8e47ed12-c658-4252-b126-381df8d52a3d", to_path="/tmp/data.h5ad")