DART package¶

Attribute configuration¶

class DART.parameters.Parameters(**kwargs)¶

Manages package-wide parameters.

Parameters:: **kwargs – Specified parameter values. Default values will be used for any parameter not specified.

Notes

parameters is a global version of Parameters with all default values.

class DART.comparison.Comparison(criteria1: dict, criteria2: dict, ignore_inherent: bool)¶

Helps organize complex comparison outputs. The actual comparison process is part of Dataset.

Parameters:

criteria1 (dict) – Criteria describing the two defined groups being compared.
criteria2 (dict) – Criteria describing the two defined groups being compared.
ignore_inherent (bool) – The ignore_inherent setting passed to Dataset.compare().

export(orient: Literal['minimal', 'maximal', 'tabular'] = 'minimal', include_empty: bool = False) → dict | list¶

Exports the comparison information to a dictionary or a list (depending on the value of orient).

Parameters:

orient ({"minimal","maximal", "tabular"}) – Format of how the information should be saved. “minimal” avoids repeating information that applies to multiple ComparisonItem objects. “maximal” repeats information, producing a more reader-friendly output. “tabular” similar to “maximal”, but doesn’t include Comparison-wide information (such as the original two criteria) and formats lists into strings.
include_empty (bool, default = False) – If False, ComparisonItem objects with no similarity values will be excluded.