aigct.reporter
==============

.. py:module:: aigct.reporter


Attributes
----------

.. autoapisummary::

   aigct.reporter.VARIANT_EFFECT_SCORE_COLS


Classes
-------

.. autoapisummary::

   aigct.reporter.VEAnalysisReporter


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

.. py:data:: VARIANT_EFFECT_SCORE_COLS
   :value: ['SCORE_SOURCE', 'GENOME_ASSEMBLY', 'CHROMOSOME', 'POSITION', 'REFERENCE_NUCLEOTIDE',...


.. py:class:: VEAnalysisReporter

   Report analysis results


   .. py:method:: _write_metric_dataframe(out, metric_df: pandas.DataFrame)


   .. py:method:: _write_summary(out, metrics: aigct.model.VEAnalysisResult)


   .. py:method:: write_summary(metrics: aigct.model.VEAnalysisResult, dir: str = None)

      Generate a report summarizing the results of an analysis. It will
      be written either to the screen or to a file.

      Parameters
      ----------
      results : VEAnalysisResult
          Object containing the results of an analysis.
      dir : str, optional
          Directory to place the report file. The file name will
          begin with variant_bm_summary and suffixed
          by a unique timestamp. If not specified will print to the
          screen.



   .. py:method:: write_calibration_summary(metrics: aigct.model.VEAnalysisCalibrationResult, dir: str = None)

      Generate a report summarizing the results of a calibration
      analysis. It will be written either to the screen or to a file.

      Parameters
      ----------
      results : VEAnalysisCalibrationResult
          Calibration result object returned by calling
          VEAnalyzer.compute_calibration_metrics.
      dir : str, optional
          Directory to place the report file. The file name will
          begin with variant_bm_calibration_summary and suffixed
          by a unique timestamp. If not specified will print to the
          screen.



   .. py:method:: _write_calibration_summary(out, metrics: aigct.model.VEAnalysisCalibrationResult)