cas.matrix_file package

Submodules

class cas.matrix_file.base_resolver.BaseMatrixFileResolver[source]

Bases: object

Base abstract matrix file Resolver

abstract resolve_matrix_file(dataset_id)[source]

Resolves matrix file identified by the given dataset_id. :type dataset_id: :param dataset_id: dataset identifier

abstract resolve_matrix_file_path(dataset_id)[source]

Resolves matrix file identified by the given dataset_id and returns its path. :type dataset_id: :param dataset_id: dataset identifier

class cas.matrix_file.cxg_resolver.CxGDatasetResolver(cache_folder_path)[source]

CellxGene dataset resolver.

resolve_matrix_file(dataset_id)[source]

Resolves matrix file identified by the given dataset_id. :type dataset_id: :param dataset_id: dataset identifier

resolve_matrix_file_path(dataset_id)[source]

Resolves matrix file identified by the given dataset_id and returns its path. :type dataset_id: :param dataset_id: dataset identifier

cas.matrix_file.cxg_resolver.list_cached_datasets(cache_folder_path)[source]

cas.matrix_file.resolver.resolve_matrix_file(matrix_file_id, cache_folder_path=None)[source]

Resolves matrix file identified by the given matrix_file_id.

Parameters:

matrix_file_id (str) – dataset identifier
cache_folder_path (Optional[str]) – (Optional) matrix file cache folder path

Return type:

Optional[AnnData]

Returns:

AnnData object

cas.matrix_file.resolver.resolve_matrix_file_path(matrix_file_id, cache_folder_path=None)[source]

Resolves matrix file identified by the given matrix_file_id.

Parameters:

matrix_file_id (str) – dataset identifier
cache_folder_path (Optional[str]) – (Optional) matrix file cache folder path

Return type:

str

Returns:

AnnData file path