Merge pull request #45 from posit-dev/feat-gt-color-box

feat `gt_color_box()`

Author: juleswg23

docs/_quarto.yml

@@ -45,6 +45,7 @@ quartodoc:
       contents:
         - gt_highlight_cols
         - gt_hulk_col_numeric
+        - gt_color_box
 
     - title: Themes
       desc: Functions to generate themes.

docs/_sidebar.yml

@@ -9,6 +9,7 @@ website:
     - contents:
       - reference/gt_highlight_cols.qmd
       - reference/gt_hulk_col_numeric.qmd
+      - reference/gt_color_box.qmd
       section: Colors
     - contents:
       - reference/gt_theme_538.qmd

docs/objects.json

@@ -1 +1 @@
-{"project": "gt_extras", "version": "0.0.9999", "count": 32, "items": [{"name": "gt_extras.gt_plt_bar", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_bar.html#gt_extras.gt_plt_bar", "dispname": "-"}, {"name": "gt_extras.plotting.gt_plt_bar", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_bar.html#gt_extras.gt_plt_bar", "dispname": "gt_extras.gt_plt_bar"}, {"name": "gt_extras.gt_plt_dot", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_dot.html#gt_extras.gt_plt_dot", "dispname": "-"}, {"name": "gt_extras.plotting.gt_plt_dot", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_dot.html#gt_extras.gt_plt_dot", "dispname": "gt_extras.gt_plt_dot"}, {"name": "gt_extras.gt_highlight_cols", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_highlight_cols.html#gt_extras.gt_highlight_cols", "dispname": "-"}, {"name": "gt_extras.colors.gt_highlight_cols", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_highlight_cols.html#gt_extras.gt_highlight_cols", "dispname": "gt_extras.gt_highlight_cols"}, {"name": "gt_extras.gt_hulk_col_numeric", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hulk_col_numeric.html#gt_extras.gt_hulk_col_numeric", "dispname": "-"}, {"name": "gt_extras.colors.gt_hulk_col_numeric", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hulk_col_numeric.html#gt_extras.gt_hulk_col_numeric", "dispname": "gt_extras.gt_hulk_col_numeric"}, {"name": "gt_extras.gt_theme_538", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_538.html#gt_extras.gt_theme_538", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_538", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_538.html#gt_extras.gt_theme_538", "dispname": "gt_extras.gt_theme_538"}, {"name": "gt_extras.gt_theme_espn", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_espn.html#gt_extras.gt_theme_espn", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_espn", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_espn.html#gt_extras.gt_theme_espn", "dispname": "gt_extras.gt_theme_espn"}, {"name": "gt_extras.gt_theme_guardian", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_guardian.html#gt_extras.gt_theme_guardian", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_guardian", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_guardian.html#gt_extras.gt_theme_guardian", "dispname": "gt_extras.gt_theme_guardian"}, {"name": "gt_extras.gt_theme_nytimes", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_nytimes.html#gt_extras.gt_theme_nytimes", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_nytimes", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_nytimes.html#gt_extras.gt_theme_nytimes", "dispname": "gt_extras.gt_theme_nytimes"}, {"name": "gt_extras.gt_theme_excel", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_excel.html#gt_extras.gt_theme_excel", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_excel", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_excel.html#gt_extras.gt_theme_excel", "dispname": "gt_extras.gt_theme_excel"}, {"name": "gt_extras.gt_theme_dot_matrix", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dot_matrix.html#gt_extras.gt_theme_dot_matrix", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_dot_matrix", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dot_matrix.html#gt_extras.gt_theme_dot_matrix", "dispname": "gt_extras.gt_theme_dot_matrix"}, {"name": "gt_extras.gt_theme_dark", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dark.html#gt_extras.gt_theme_dark", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_dark", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dark.html#gt_extras.gt_theme_dark", "dispname": "gt_extras.gt_theme_dark"}, {"name": "gt_extras.gt_theme_pff", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_pff.html#gt_extras.gt_theme_pff", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_pff", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_pff.html#gt_extras.gt_theme_pff", "dispname": "gt_extras.gt_theme_pff"}, {"name": "gt_extras.fa_icon_repeat", "domain": "py", "role": "function", "priority": "1", "uri": "reference/fa_icon_repeat.html#gt_extras.fa_icon_repeat", "dispname": "-"}, {"name": "gt_extras.icons.fa_icon_repeat", "domain": "py", "role": "function", "priority": "1", "uri": "reference/fa_icon_repeat.html#gt_extras.fa_icon_repeat", "dispname": "gt_extras.fa_icon_repeat"}, {"name": "gt_extras.gt_fa_rating", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_fa_rating.html#gt_extras.gt_fa_rating", "dispname": "-"}, {"name": "gt_extras.icons.gt_fa_rating", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_fa_rating.html#gt_extras.gt_fa_rating", "dispname": "gt_extras.gt_fa_rating"}, {"name": "gt_extras.gt_hyperlink", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hyperlink.html#gt_extras.gt_hyperlink", "dispname": "-"}, {"name": "gt_extras.html.gt_hyperlink", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hyperlink.html#gt_extras.gt_hyperlink", "dispname": "gt_extras.gt_hyperlink"}, {"name": "gt_extras.with_tooltip", "domain": "py", "role": "function", "priority": "1", "uri": "reference/with_tooltip.html#gt_extras.with_tooltip", "dispname": "-"}, {"name": "gt_extras.html.with_tooltip", "domain": "py", "role": "function", "priority": "1", "uri": "reference/with_tooltip.html#gt_extras.with_tooltip", "dispname": "gt_extras.with_tooltip"}]}
+{"project": "gt_extras", "version": "0.0.9999", "count": 34, "items": [{"name": "gt_extras.gt_plt_bar", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_bar.html#gt_extras.gt_plt_bar", "dispname": "-"}, {"name": "gt_extras.plotting.gt_plt_bar", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_bar.html#gt_extras.gt_plt_bar", "dispname": "gt_extras.gt_plt_bar"}, {"name": "gt_extras.gt_plt_dot", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_dot.html#gt_extras.gt_plt_dot", "dispname": "-"}, {"name": "gt_extras.plotting.gt_plt_dot", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_plt_dot.html#gt_extras.gt_plt_dot", "dispname": "gt_extras.gt_plt_dot"}, {"name": "gt_extras.gt_highlight_cols", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_highlight_cols.html#gt_extras.gt_highlight_cols", "dispname": "-"}, {"name": "gt_extras.colors.gt_highlight_cols", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_highlight_cols.html#gt_extras.gt_highlight_cols", "dispname": "gt_extras.gt_highlight_cols"}, {"name": "gt_extras.gt_hulk_col_numeric", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hulk_col_numeric.html#gt_extras.gt_hulk_col_numeric", "dispname": "-"}, {"name": "gt_extras.colors.gt_hulk_col_numeric", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hulk_col_numeric.html#gt_extras.gt_hulk_col_numeric", "dispname": "gt_extras.gt_hulk_col_numeric"}, {"name": "gt_extras.gt_color_box", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_color_box.html#gt_extras.gt_color_box", "dispname": "-"}, {"name": "gt_extras.colors.gt_color_box", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_color_box.html#gt_extras.gt_color_box", "dispname": "gt_extras.gt_color_box"}, {"name": "gt_extras.gt_theme_538", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_538.html#gt_extras.gt_theme_538", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_538", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_538.html#gt_extras.gt_theme_538", "dispname": "gt_extras.gt_theme_538"}, {"name": "gt_extras.gt_theme_espn", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_espn.html#gt_extras.gt_theme_espn", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_espn", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_espn.html#gt_extras.gt_theme_espn", "dispname": "gt_extras.gt_theme_espn"}, {"name": "gt_extras.gt_theme_guardian", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_guardian.html#gt_extras.gt_theme_guardian", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_guardian", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_guardian.html#gt_extras.gt_theme_guardian", "dispname": "gt_extras.gt_theme_guardian"}, {"name": "gt_extras.gt_theme_nytimes", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_nytimes.html#gt_extras.gt_theme_nytimes", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_nytimes", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_nytimes.html#gt_extras.gt_theme_nytimes", "dispname": "gt_extras.gt_theme_nytimes"}, {"name": "gt_extras.gt_theme_excel", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_excel.html#gt_extras.gt_theme_excel", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_excel", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_excel.html#gt_extras.gt_theme_excel", "dispname": "gt_extras.gt_theme_excel"}, {"name": "gt_extras.gt_theme_dot_matrix", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dot_matrix.html#gt_extras.gt_theme_dot_matrix", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_dot_matrix", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dot_matrix.html#gt_extras.gt_theme_dot_matrix", "dispname": "gt_extras.gt_theme_dot_matrix"}, {"name": "gt_extras.gt_theme_dark", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dark.html#gt_extras.gt_theme_dark", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_dark", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_dark.html#gt_extras.gt_theme_dark", "dispname": "gt_extras.gt_theme_dark"}, {"name": "gt_extras.gt_theme_pff", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_pff.html#gt_extras.gt_theme_pff", "dispname": "-"}, {"name": "gt_extras.themes.gt_theme_pff", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_theme_pff.html#gt_extras.gt_theme_pff", "dispname": "gt_extras.gt_theme_pff"}, {"name": "gt_extras.fa_icon_repeat", "domain": "py", "role": "function", "priority": "1", "uri": "reference/fa_icon_repeat.html#gt_extras.fa_icon_repeat", "dispname": "-"}, {"name": "gt_extras.icons.fa_icon_repeat", "domain": "py", "role": "function", "priority": "1", "uri": "reference/fa_icon_repeat.html#gt_extras.fa_icon_repeat", "dispname": "gt_extras.fa_icon_repeat"}, {"name": "gt_extras.gt_fa_rating", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_fa_rating.html#gt_extras.gt_fa_rating", "dispname": "-"}, {"name": "gt_extras.icons.gt_fa_rating", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_fa_rating.html#gt_extras.gt_fa_rating", "dispname": "gt_extras.gt_fa_rating"}, {"name": "gt_extras.gt_hyperlink", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hyperlink.html#gt_extras.gt_hyperlink", "dispname": "-"}, {"name": "gt_extras.html.gt_hyperlink", "domain": "py", "role": "function", "priority": "1", "uri": "reference/gt_hyperlink.html#gt_extras.gt_hyperlink", "dispname": "gt_extras.gt_hyperlink"}, {"name": "gt_extras.with_tooltip", "domain": "py", "role": "function", "priority": "1", "uri": "reference/with_tooltip.html#gt_extras.with_tooltip", "dispname": "-"}, {"name": "gt_extras.html.with_tooltip", "domain": "py", "role": "function", "priority": "1", "uri": "reference/with_tooltip.html#gt_extras.with_tooltip", "dispname": "gt_extras.with_tooltip"}]}

gt_extras/__init__.py

@@ -10,7 +10,7 @@
     gt_theme_pff,
 )
 
-from .colors import gt_highlight_cols, gt_hulk_col_numeric
+from .colors import gt_highlight_cols, gt_hulk_col_numeric, gt_color_box
 
 from .icons import fa_icon_repeat, gt_fa_rating
 
@@ -30,6 +30,7 @@
 
     "gt_highlight_cols",
     "gt_hulk_col_numeric",
+    "gt_color_box",
 
     "fa_icon_repeat",
 

gt_extras/_utils_plotting.py renamed to gt_extras/_utils_column.py

@@ -55,6 +55,8 @@ def _scale_numeric_column(
     col_name: str,
     col_vals: list,
     domain: list[int] | list[float] | None = None,
+    default_domain_min_zero: bool = True,
+
 ) -> list[float]:
     """
     Process and scale a numeric column, handling NA values.
@@ -68,8 +70,9 @@ def _scale_numeric_column(
     col_vals
         The column values
     domain
-        The domain for scaling. If None, uses [0, max(values)]
-
+        The domain for scaling. If None, uses a default domain, based on `default_domain_min_zero`
+    default_domain_min_zero
+        If true, the defsult domain will be [0, max(values)], otherwise [min(values), max(values)]
     Returns
     -------
     list[float]
@@ -87,9 +90,12 @@ def _scale_numeric_column(
     if len(col_vals_filtered) and all(
         isinstance(x, (int, float)) for x in col_vals_filtered
     ):
-        # If `domain` is not provided, then set it to [0, max]
+        # If `domain` is not provided, then set it to a default domain
         if domain is None:
-            domain = [0, max(col_vals_filtered)]
+            if default_domain_min_zero:
+                domain = [0, max(col_vals_filtered)]
+            else:
+                domain = [min(col_vals_filtered), max(col_vals_filtered)]
 
         # Rescale based on the given domain
         scaled_vals = _rescale_numeric(df=data_table, vals=col_vals, domain=domain)