prolint.analysis.metrics
========================

.. py:module:: prolint.analysis.metrics

.. autoapi-nested-parse::

   Per-residue contact metrics analysis.



Classes
-------

.. autoapisummary::

   prolint.analysis.metrics.MetricsAnalysis


Module Contents
---------------

.. py:class:: MetricsAnalysis(universe, contacts: prolint.core.contact_provider.ComputedContacts)

   Bases: :py:obj:`prolint.analysis.base.BaseAnalysis`


   Per-residue contact metrics analysis.

   Computes per-residue contact metrics (occupancy, mean, max, sum) and
   returns values for all query residues in the universe.

   .. seealso::

      :py:obj:`ExactContacts.compute_metric`
          Underlying metric computation


   .. py:attribute:: name
      :value: 'metrics'


      Analysis name for registry.


   .. py:attribute:: description
      :value: 'Per-residue contact metrics (occupancy, mean, max, sum)'


      Human-readable description.


   .. py:method:: run(**kwargs) -> prolint.analysis.base.AnalysisResult

      Compute per-residue contact metrics.

      :param metric: Metric to compute. One of "occupancy", "mean", "max", "sum".
      :type metric: str, default="occupancy"
      :param database_type: Filter by database residue name (e.g., "CHOL").
      :type database_type: str, optional
      :param query_residues: Specific query residues to include. If None, includes all.
      :type query_residues: list of int, optional

      :returns: Result with data containing:

                - residues : list of dict with "resid" and "resname"
                - values : list of float metric values
                - metric : str metric name
                - database_type : str or None
      :rtype: AnalysisResult