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.

   Parameters
   ----------
   dataNode : DataNode
       Application data node
   mr_id : str
       Multirun id

   Returns
   -------
   str
       Report string


.. py:function:: sensors_table(sensors: List[Dict[str, Any]], by_rank=True) -> str

   Create a text table from a list of sensor readings.

   Parameters
   ----------
   sensors : List[Dict[str, Any]]
       List of sensor readings

   Returns
   -------
   str
       Table string