cellxgene_census.get_census_version_description

cellxgene_census.get_census_version_description(census_version: str) → CensusVersionDescription

Get release description for given Census version, from the Census release directory.

Parameters:

census_version – The census version name.

Returns:

CensusVersionDescription - a dictionary containing a description of the release.

Raises:

ValueError – if unknown census_version value.

Lifecycle

maturing

See also

get_census_version_directory(): returns the entire directory as a dict.

Examples

>>> cellxgene_census.get_census_version_description("latest")
{'release_date': None,
'release_build': '2022-12-01',
'soma': {'uri': 's3://cellxgene-data-public/cell-census/2022-12-01/soma/',
's3_region': 'us-west-2'},
'h5ads': {'uri': 's3://cellxgene-data-public/cell-census/2022-12-01/h5ads/',
's3_region': 'us-west-2'}}