Merge pull request #136 from posit-dev/feat-gt-plt-summary

feat: `gt_plt_summary()`

Author: juleswg23

docs/_quarto.yml

@@ -53,6 +53,7 @@ quartodoc:
         - gt_plt_conf_int
         - gt_plt_dot
         - gt_plt_dumbbell
+        - gt_plt_summary
         - gt_plt_winloss
 
     - title: Colors

docs/examples/index.qmd

@@ -158,6 +158,11 @@ addEventListener('resize', setTableWidths);
 [gt_plt_dumbbell](./with-code.html#gt_plt_dumbbell){.embed-hover-overlay}
 :::
 
+:::{.masonry-item style="--width: 521;"}
+{{< embed with-code.qmd#gt_plt_summary >}}
+[gt_plt_summary](./with-code.html#gt_plt_summary){.embed-hover-overlay}
+:::
+
 :::{.masonry-item style="--width: 167;"}
 {{< embed with-code.qmd#gt_plt_winloss >}}
 [gt_plt_winloss](./with-code.html#gt_plt_winloss){.embed-hover-overlay}

docs/examples/with-code.qmd

@@ -2,6 +2,7 @@
 title: Examples With Code
 jupyter: python3
 echo: false
+collapse-level: 3
 ---
 <style>
 
@@ -228,6 +229,37 @@ gt.pipe(
 ```
 {{< include ./_show-last.qmd >}}
 
+### [gt_plt_summary](https://posit-dev.github.io/gt-extras/reference/gt_plt_summary.html){title="Click for reference"}
+```{python}
+# | label: gt_plt_summary
+import polars as pl
+from great_tables import GT
+import gt_extras as gte
+from datetime import datetime
+
+df = pl.DataFrame({
+    "Date": [
+        datetime(2024, 1, 1),
+        datetime(2024, 1, 2),
+        datetime(2024, 1, 7),
+        datetime(2024, 1, 8),
+        datetime(2024, 1, 13),
+        datetime(2024, 1, 16),
+        datetime(2024, 1, 20),
+        datetime(2024, 1, 22),
+        datetime(2024, 2, 1),
+    ] * 5,
+    "Value": [10, 15, 20, None, 25, 18, 22, 30, 40] * 5,
+    "Category": ["A", "B", "C", "A", "B", "C", "D", None, None] * 5,
+    "Boolean": [True, False, True] * 15,
+    "Status": ["Active", "Inactive", None] * 15,
+})
+
+gte.gt_plt_summary(df)
+```
+{{< include ./_show-last.qmd >}}
+
+
 ### [gt_plt_winloss](https://posit-dev.github.io/gt-extras/reference/gt_plt_winloss.html){title="Click for reference"}
 ```{python}
 # | label: gt_plt_winloss

gt_extras/__init__.py

@@ -21,6 +21,7 @@
     gt_plt_winloss,
 )
 from .styling import gt_add_divider
+from .summary import gt_plt_summary
 from .themes import (
     gt_theme_538,
     gt_theme_dark,
@@ -66,4 +67,5 @@
     "add_text_img",
     "img_header",
     "gt_add_divider",
+    "gt_plt_summary",
 ]