Summary Statistics

class oaklib.interfaces.summary_statistics_interface.SummaryStatisticsInterface(resource: ~oaklib.resource.OntologyResource | None = None, strict: bool = False, _multilingual: bool | None = None, autosave: bool = <factory>, exclude_owl_top_and_bottom: bool = <factory>, ontology_metamodel_mapper: ~oaklib.mappers.ontology_metadata_mapper.OntologyMetadataMapper | None = None, _converter: ~curies.api.Converter | None = None, auto_relax_axioms: bool | None = None, cache_lookups: bool = False, property_cache: ~oaklib.utilities.keyval_cache.KeyValCache = <factory>, _edge_index: ~oaklib.indexes.edge_index.EdgeIndex | None = None, _entailed_edge_index: ~oaklib.indexes.edge_index.EdgeIndex | None = None, _prefix_map: ~typing.Mapping[str, str] | None = None)[source]

generates summary statistics

Uses SummaryStatistics datamodel, see Datamodels

global_summary_statistics(branches: Dict[str, List[str]] | None = None, group_by: str | None = None, values: List[Any] | None = None, include_entailed: bool = False, prefixes: List[str] | None = None) → GroupedStatistics[source]

Gets summary statistics for all ontologies treated as a single ontology.

Parameters:

  • branches – if provided, only statistics for the given branch roots will be returned

  • group_by – if provided, statistics will be grouped by the values of this property

  • values – if provided, only statistics where the group_by property value matches this will be considered

  • include_entailed – include inference

  • prefixes – if provided, only statistics for entities with these prefixes will be considered

Returns:

branch_summary_statistics(branch_name: str | None = None, branch_roots: List[str] | None = None, property_values: Dict[str, Any] | None = None, include_entailed=False, parent: GroupedStatistics | None = None, prefixes: List[str] | None = None) → UngroupedStatistics[source]

Gets summary statistics for all ontologies treated as a single ontology.

Note that different implementations may implement subsets of the full stats datamodel.

Parameters:

  • branch_name

  • branch_roots – if provided, only statistics for the given branch roots will be returned

  • property_values – if provided, only statistics for entities that match these will be considered

  • include_entailed – if True, include statistics for entailed edges

  • parent – set if this is a partition of a larger group

  • prefixes – if provided, only statistics for entities with these prefixes will be considered

Returns:

metadata_property_summary_statistics(metadata_property: str) → Dict[Any, int][source]

Gets summary statistics for all ontologies wrapped as multiple dictionaries keyed by ontology CURIE

Returns:

summary_statistic_description(metric: str) → str[source]

Examines the data dictionary to retrieve the definition of a metric

Any dictionary can be used, but summary_statistics_datamodel is favored

Parameters:

metric

Returns: