coco_pipe.report.qc
===================

.. py:module:: coco_pipe.report.qc

.. autoapi-nested-parse::

   QC section builder for HTML reports.

   Produces the standardised "Data Quality (QC)" :class:`~coco_pipe.report.core.Section`
   from a :class:`~coco_pipe.io.quality.QCResult`.  Consumed by the decoding and
   dimensionality-reduction report builders.



Functions
---------

.. autoapisummary::

   coco_pipe.report.qc.build_qc_section


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

.. py:function:: build_qc_section(qc_result, *, compact = False, page_size = 10)

   Build the standardised QC drop-log report section.

   :param qc_result: Populated result from :func:`~coco_pipe.io.quality.run_qc`.
   :param compact: Paginate long detail tables when ``True``.
   :param page_size: Number of rows shown per page in compact tables.

   :returns: A fully populated report section ready to be added to a
             :class:`~coco_pipe.report.core.Report`.
   :rtype: Section