scverse_misc.datasets.DatasetEntry

Contents

scverse_misc.datasets.DatasetEntry#

class scverse_misc.datasets.DatasetEntry(name, type, files, metadata=<factory>)#

A named dataset made up of one or more files.

metadata holds everything in the YAML row other than type and files (e.g. shape, library_id, doc_header); the core does not interpret it.

Attributes table#

`name`
`type`
`files`
`metadata`

Attributes#

DatasetEntry.name: str#

DatasetEntry.type: str#

DatasetEntry.files: tuple[FileEntry, ...]#

DatasetEntry.metadata: Mapping[str, Any]#

Methods#

DatasetEntry.file(*, name=None, suffix=None)#

Return the file matching name (exact) or suffix (endswith). Raises unless exactly one matches.

Return type:: FileEntry