goad-toolkit 0.2.9__tar.gz → 0.2.11__tar.gz

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: goad-toolkit
-Version: 0.2.9
+Version: 0.2.11
 Summary: An extensible toolkit for Goal Oriented Analysis of Data
 Project-URL: Github, https://github.com/raoulg/goad_toolkit
 Author-email: raoul grouls <Raoul.Grouls@han.nl>

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/docs/03-plot-composition.md

@@ -81,8 +81,10 @@ The contract:
 - Return `(self.fig, self.ax)` from `build`. Callers chain on it.
 
 `create_figure(n_plots=...)` handles the layout: one axis for a single plot, otherwise a grid
-capped at three columns with the unused axes hidden. Labels, grid and titles are applied to
-every visible axis.
+wrapping at `settings.max_cols` columns — three by default — with the unused axes hidden.
+Labels, grid and titles are applied to every visible axis. Set `max_cols=4` for a quartet or
+`max_cols=2` for a square grid; four panels at the default wrap to 3 + 1, which is rarely
+what a set of four wants.
 
 ## 3.4 `plot_on`: layering
 

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/docs/08-api-reference.md

@@ -11,7 +11,7 @@ Pydantic settings objects. Both have a readable `__repr__`.
 
 ```python
 class FileConfig(BaseModel):
-    data_dir: Path = Path.home() / ".cache/mads_datasets/covid"
+    data_dir: Path = Path.home() / ".cache/goad/covid"
     filename: Path = Path("covid.csv")
     url: str = "https://raw.githubusercontent.com/mzelst/covid-19/master/data/rivm_by_day.csv"
     date_column: Optional[str] = "date"
@@ -300,6 +300,7 @@ class PlotSettings:
     grid: bool = False
     grid_alpha: Optional[float] = None
     subplot_titles: List[str] = field(default_factory=list)
+    max_cols: int = 3                                    # columns before wrapping
     highlight: List[str] = field(default_factory=list)   # defaults for HighlightCategory
     base_color: str = "lightgrey"
     highlight_color: str = "crimson"

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "goad-toolkit"
-version = "0.2.9"
+version = "0.2.11"
 description = "An extensible toolkit for Goal Oriented Analysis of Data"
 readme = "README.md"
 authors = [

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/src/goad_toolkit/config.py

@@ -12,7 +12,7 @@ class FileConfig(BaseModel):
     index. The reader is picked from the file suffix (`.csv`, `.parquet`).
     """
 
-    data_dir: Path = Path.home() / ".cache/mads_datasets/covid"
+    data_dir: Path = Path.home() / ".cache/goad/covid"
     filename: Path = Path("covid.csv")
     url: str = (
         "https://raw.githubusercontent.com/mzelst/covid-19/master/data/rivm_by_day.csv"

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/src/goad_toolkit/visualizer.py

@@ -30,6 +30,7 @@ class PlotSettings:
     grid: bool = False  # Added grid option
     grid_alpha: Optional[float] = None  # Grid transparency
     subplot_titles: List[str] = field(default_factory=list)  # Titles for subplots
+    max_cols: int = 3  # Columns before create_figure wraps to a new row
     highlight: List[str] = field(default_factory=list)  # Categories to pick out
     base_color: str = "lightgrey"  # Everything that is not highlighted
     highlight_color: str = "crimson"  # The categories that are
@@ -39,8 +40,9 @@ class PlotSettings:
             f"PlotSettings(figsize={self.figsize},\n title={self.title},\n "
             f"xlabel={self.xlabel},\n ylabel={self.ylabel},\n "
             f"legend_title={self.legend_title},\n grid={self.grid},\n "
-            f"grid_alpha={self.grid_alpha},\n highlight={self.highlight},\n "
-            f"base_color={self.base_color},\n highlight_color={self.highlight_color}"
+            f"grid_alpha={self.grid_alpha},\n max_cols={self.max_cols},\n "
+            f"highlight={self.highlight},\n base_color={self.base_color},\n "
+            f"highlight_color={self.highlight_color}"
         )
 
 
@@ -72,7 +74,7 @@ class BasePlot(ABC):
             axes = [self.ax]
         else:
             # Determine grid layout
-            grid_cols = min(3, n_plots)  # Max 3 columns
+            grid_cols = min(self.settings.max_cols, n_plots)
             grid_rows = int(np.ceil(n_plots / grid_cols))
             # Create subplot grid
             self.fig, axes = plt.subplots(

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/tests/test_visualizer.py

@@ -281,6 +281,30 @@ def facecolours(ax) -> list:
     return [patch.get_facecolor() for patch in ax.patches]
 
 
+def test_create_figure_wraps_at_three_columns_by_default():
+    host = LinePlot(PlotSettings())
+    fig, axes = host.create_figure(n_plots=4)
+
+    visible = [ax for ax in axes if ax.get_visible()]
+    assert len(visible) == 4
+    assert fig.axes[0].get_subplotspec().get_gridspec().get_geometry() == (2, 3)
+
+
+def test_max_cols_puts_four_panels_on_one_row():
+    host = LinePlot(PlotSettings(max_cols=4))
+    fig, axes = host.create_figure(n_plots=4)
+
+    assert fig.axes[0].get_subplotspec().get_gridspec().get_geometry() == (1, 4)
+    assert all(ax.get_visible() for ax in axes)
+
+
+def test_max_cols_of_two_gives_a_square_grid():
+    host = LinePlot(PlotSettings(max_cols=2))
+    fig, axes = host.create_figure(n_plots=4)
+
+    assert fig.axes[0].get_subplotspec().get_gridspec().get_geometry() == (2, 2)
+
+
 def test_annotate_writes_the_text_on_the_axis():
     host = LinePlot(PlotSettings())
     host.create_figure()

{goad_toolkit-0.2.9 → goad_toolkit-0.2.11}/uv.lock

@@ -383,7 +383,7 @@ wheels = [
 
 [[package]]
 name = "goad-toolkit"
-version = "0.2.9"
+version = "0.2.11"
 source = { editable = "." }
 dependencies = [
     { name = "loguru" },