Reporting

curifactory/reporting.py

@@ -145,6 +145,28 @@ def html(self) -> Union[str, list[str]]:
         return self.html_string
 
 
+class LatexTableReporter(Reportable):
+    """Output a latex string for a pandas dataframe, useful for copying a table from a report
+    into a latex paper.
+
+    Args:
+        df (pd.DataFrame): The pandas dataframe to render in latex in the report.
+        kwargs: Any arguments to pass to `pandas.io.formats.style.Styler.to_latex <https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.to_latex.html#pandas.io.formats.style.Styler.to_latex>`_
+    """
+
+    def __init__(self, df: pd.DataFrame, name: str = None, group: str = None, **kwargs):
+        self.df = df
+        self.kwargs = kwargs
+        super().__init__(name=name, group=group)
+
+    def html(self) -> list[str]:
+        return [
+            "<pre>",
+            self.df.style.to_latex(**self.kwargs),
+            "</pre>",
+        ]
+
+
 class DFReporter(Reportable):
     """Adds an HTML table to the report for the given pandas dataframe.
 
@@ -186,11 +208,7 @@ def html(self) -> list[str]:
             output.append(f"<th>{index}</th>")
 
             for item in row:
-                if (
-                    type(item) == float
-                    or type(item) == np.float64
-                    or type(item) == np.float32
-                ):
+                if isinstance(item, (float, np.float64, np.float32)):
                     output.append(
                         "<td align='right'><pre>{0:.{1}f}</pre></td>".format(
                             item, self.float_prec

requirements.txt

@@ -1,7 +1,7 @@
 numpy
 pandas
 sphinx~=3.5.4
-jinja2<3.1
+jinja2
 autodocsumm
 sphinx-rtd-theme
 ipynb-py-convert

test/test_reporting.py

@@ -2,13 +2,19 @@
 from dataclasses import dataclass
 from enum import IntEnum
 
+import pandas as pd
 from graphviz import Digraph
 
 import curifactory as cf
 from curifactory import reporting
 from curifactory.caching import JsonCacher, PickleCacher
 from curifactory.experiment import run_experiment
-from curifactory.reporting import JsonReporter, _add_record_subgraph, render_reportable
+from curifactory.reporting import (
+    JsonReporter,
+    LatexTableReporter,
+    _add_record_subgraph,
+    render_reportable,
+)
 
 
 def test_reportables_cached(configured_test_manager):
@@ -208,3 +214,15 @@ def test_image_reporter_persists_after_original_deletion(configured_test_manager
     assert os.path.exists(
         f"{configured_test_manager.reports_path}/{configured_test_manager.get_reference_name()}/reportables/test_save_manual_image_0.png"
     )
+
+
+def test_latex_table_reporter():
+    """The LatexTableReporter should correctly...output a latex table? This is just
+    a basic functionality test."""
+    df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
+    r = LatexTableReporter(df)
+    assert r.html() == [
+        "<pre>",
+        "\\begin{tabular}{lrr}\n & a & b \\\\\n0 & 1 & 4 \\\\\n1 & 2 & 5 \\\\\n2 & 3 & 6 \\\\\n\\end{tabular}\n",
+        "</pre>",
+    ]