Comparison Data Extractor

GitHub Link to Code.

Helper class for extracting data from comparison configurations.

Provides methods to extract data selector names and other metadata from ComparisonData objects for use in plotting workflows.

class mdxplain.plots.helper.comparison_data_extractor.ComparisonDataExtractor

Helper class for extracting data from comparison configurations.

Provides static methods to extract data selector names and other metadata from ComparisonData objects needed for plotting.

Examples

>>> # Get all data selectors from a comparison
>>> selectors = ComparisonDataExtractor.get_all_data_selectors_from_comparison(
...     pipeline_data, "clusters_comparison"
... )

static get_all_data_selectors_from_comparison(pipeline_data: PipelineData, comparison_name: str) → list

Get all unique data selector names from a comparison.

Returns the data selector names directly from the comparison’s data_selectors attribute, which is set during comparison creation.

Parameters

pipeline_dataPipelineData: Pipeline data container with comparison configurations
comparison_namestr: Name of the comparison

Returns

List[str]: Sorted list of unique data selector names

Raises

ValueError: If comparison not found

Examples

>>> # Get all data selectors from a comparison
>>> selectors = ComparisonDataExtractor.get_all_data_selectors_from_comparison(
...     pipeline_data, "clusters_comparison"
... )
>>> print(selectors)  # ["cluster_0", "cluster_1", "cluster_2", "folded"]

Notes

Returns the data_selectors attribute from ComparisonData, which contains all data selectors involved in the comparison. The list is sorted for consistent visualization ordering.