Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.model.dataset_collections.types package

class galaxy.model.dataset_collections.types.BaseDatasetCollectionType[source]

Bases: object

collection_type: str
abstract generate_elements(dataset_instances: Mapping[str, DatasetCollection | DatasetInstance], **kwds) → Iterable[DatasetCollectionElement][source]

Generate DatasetCollectionElements with corresponding to the supplied dataset instances or throw exception if this is not a valid collection of the specified type.

Submodules

galaxy.model.dataset_collections.types.list module

class galaxy.model.dataset_collections.types.list.ListDatasetCollectionType[source]

Bases: BaseDatasetCollectionType

A flat list of named elements.

collection_type: str = 'list'
generate_elements(dataset_instances: DatasetInstanceMapping, **kwds) → Iterable[DatasetCollectionElement][source]

Generate DatasetCollectionElements with corresponding to the supplied dataset instances or throw exception if this is not a valid collection of the specified type.

galaxy.model.dataset_collections.types.paired module

class galaxy.model.dataset_collections.types.paired.PairedDatasetCollectionType[source]

Bases: BaseDatasetCollectionType

Paired (left/right) datasets.

collection_type: str = 'paired'
generate_elements(dataset_instances: DatasetInstanceMapping, **kwds) → Iterable[DatasetCollectionElement][source]

Generate DatasetCollectionElements with corresponding to the supplied dataset instances or throw exception if this is not a valid collection of the specified type.

prototype_elements(**kwds)[source]