perun.io.text_report
====================

.. py:module:: perun.io.text_report

.. autoapi-nested-parse::

   Text report module.



Attributes
----------

.. autoapisummary::

   perun.io.text_report.log
   perun.io.text_report.tableMetrics
   perun.io.text_report.regionMetrics


Functions
---------

.. autoapisummary::

   perun.io.text_report.textReport
   perun.io.text_report.sensors_table


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

.. py:data:: log

.. py:data:: tableMetrics

.. py:data:: regionMetrics

.. py:function:: textReport(dataNode: perun.data_model.data.DataNode, mr_id: str) -> str

   Create text report from selected MULTI_RUN node.

   :param dataNode: Application data node
   :type dataNode: DataNode
   :param mr_id: Multirun id
   :type mr_id: str

   :returns: Report string
   :rtype: str


.. py:function:: sensors_table(sensors: list[dict[str, Any]], by_rank: bool = True) -> str

   Create a text table from a list of sensor readings.

   :param sensors: List of sensor readings
   :type sensors: list[dict[str, Any]]
   :param by_rank: If the table should separate available sensors by rank.
   :type by_rank: bool, optional

   :returns: Table string
   :rtype: str