neuro_morpho.reports.generator
==============================

.. py:module:: neuro_morpho.reports.generator

.. autoapi-nested-parse::

   Generate reports for the NeuroMorpho dataset.



Functions
---------

.. autoapisummary::

   neuro_morpho.reports.generator._aggregate_results
   neuro_morpho.reports.generator._parse_single_file
   neuro_morpho.reports.generator.generate_statistics
   neuro_morpho.reports.generator.generate_report


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

.. py:function:: _aggregate_results(stats_dir: str | pathlib.Path) -> pandas.DataFrame

   Aggregate the results of the analysis.

   The results of the ananlysis is returned as a pandas DataFrame. It is also
   saved in the `stats_dir` directory as a csv file named `aggregated_results.csv`.

   :param stats_dir: The directory containing the statistics files.
   :type stats_dir: str|Path

   :returns: The aggregated results.
   :rtype: pd.DataFrame


.. py:function:: _parse_single_file(input_file: str | pathlib.Path, output_file: str | pathlib.Path) -> None

.. py:function:: generate_statistics(in_dir: str | pathlib.Path, out_dir: str | pathlib.Path) -> None

.. py:function:: generate_report(model_out_dir: str | pathlib.Path, labeled_out_dir: str | pathlib.Path, report_out_path: str | pathlib.Path, reports: list[neuro_morpho.reports.report.report_fn]) -> None