neuro_morpho.reports.report
===========================

.. py:module:: neuro_morpho.reports.report

.. autoapi-nested-parse::

   Reports used for summarizing the results of the analysis.



Attributes
----------

.. autoapisummary::

   neuro_morpho.reports.report.ERR_NOT_IMPLEMENTED
   neuro_morpho.reports.report.ERR_COLS_DONT_MATCH
   neuro_morpho.reports.report.ERR_MISSING_FNAME_COL
   neuro_morpho.reports.report.MODEL_OUT_DIR
   neuro_morpho.reports.report.LABEL_DIR
   neuro_morpho.reports.report.REPORT_DIR
   neuro_morpho.reports.report.report_fn
   neuro_morpho.reports.report.NOISE_LEVEL_PAT


Functions
---------

.. autoapisummary::

   neuro_morpho.reports.report.transform_filename_to_group
   neuro_morpho.reports.report.noboxplot_summary
   neuro_morpho.reports.report.distribution_comparison


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

.. py:data:: ERR_NOT_IMPLEMENTED
   :value: 'The {name} method is not implemented'


.. py:data:: ERR_COLS_DONT_MATCH
   :value: 'The columns in the model and label dataframes do not match.'


.. py:data:: ERR_MISSING_FNAME_COL
   :value: 'The label data does not have a filename column.'


.. py:data:: MODEL_OUT_DIR

.. py:data:: LABEL_DIR

.. py:data:: REPORT_DIR

.. py:data:: report_fn

.. py:data:: NOISE_LEVEL_PAT

.. py:function:: transform_filename_to_group(filename: str) -> str

.. py:function:: noboxplot_summary(model_out_dir: MODEL_OUT_DIR, label_dir: LABEL_DIR, report_dir: REPORT_DIR) -> None

   Generate a summary of the results using a noboxplot-esque plot.


.. py:function:: distribution_comparison(model_output_dir: MODEL_OUT_DIR, label_dir: LABEL_DIR, report_dir: REPORT_DIR) -> None

   Generate a comparison of the results considered as a random distribution.