immuneML.workflows.instructions.dataset_generation package¶
Submodules¶
immuneML.workflows.instructions.dataset_generation.DatasetExportInstruction module¶
-
class
immuneML.workflows.instructions.dataset_generation.DatasetExportInstruction.
DatasetExportInstruction
(datasets: List[immuneML.data_model.dataset.Dataset.Dataset], exporters: List[immuneML.IO.dataset_export.DataExporter.DataExporter], result_path: Optional[pathlib.Path] = None, name: Optional[str] = None)[source]¶ Bases:
immuneML.workflows.instructions.Instruction.Instruction
DatasetExport instruction takes a list of datasets as input and outputs them in specified formats.
- Parameters
datasets (list) – a list of datasets to export in all given formats
formats (list) – a list of formats in which to export the datasets. Valid formats are class names of any non-abstract class inheriting
DataExporter
. Important note: Pickle files might not be compatible between different immuneML (sub)versions.
YAML specification:
my_dataset_export_instruction: # user-defined instruction name type: DatasetExport # which instruction to execute datasets: # list of datasets to export - my_generated_dataset - my_dataset_from_adaptive export_formats: # list of formats to export the datasets to - AIRR - Pickle
-
run
(result_path: pathlib.Path) → immuneML.workflows.instructions.dataset_generation.DatasetExportState.DatasetExportState[source]¶
immuneML.workflows.instructions.dataset_generation.DatasetExportState module¶
-
class
immuneML.workflows.instructions.dataset_generation.DatasetExportState.
DatasetExportState
(datasets: List[immuneML.data_model.dataset.Dataset.Dataset], formats: List[str], paths: dict, result_path: pathlib.Path, name: str)[source]¶ Bases:
object
-
datasets
: List[immuneML.data_model.dataset.Dataset.Dataset]¶
-
formats
: List[str]¶
-
name
: str¶
-
paths
: dict¶
-
result_path
: pathlib.Path¶
-