From 638f0a18a43d83bdfe7bdc14ce4ec34b18731a47 Mon Sep 17 00:00:00 2001 From: Jonathan Anns Date: Thu, 27 Mar 2025 14:25:16 +0800 Subject: [PATCH 1/2] test update readme --- nbs/read_me.ipynb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nbs/read_me.ipynb b/nbs/read_me.ipynb index f900170d..49cb2e3b 100644 --- a/nbs/read_me.ipynb +++ b/nbs/read_me.ipynb @@ -33,11 +33,11 @@ "\n", "1. **Python 3.13 Support**: DABEST now supports Python 3.10—3.13.\n", "\n", - "2. **Horizontal Plots**: Users can now create horizontal layout plots, providing compact data visualization. This can be achieved by setting `horizontal=True` in the `.plot()` method. See the [Horizontal Plots tutorial](../tutorials/08-horizontal_plot.html) for more details.\n", + "2. **Horizontal Plots**: Users can now create horizontal layout plots, providing compact data visualization. This can be achieved by setting `horizontal=True` in the `.plot()` method. See the [Horizontal Plots tutorial](nbs/tutorials/08-horizontal_plot.ipynb) for more details.\n", "\n", - "3. **Forest Plots**: Forest plots provide a simple and intuitive way to visualize many delta-delta (or delta *g*), mini-meta, or regular delta effect sizes at once from multiple different dabest objects without presenting the raw data. See the [Forest Plots tutorial](../tutorials/07-forest_plot.html) for more details.\n", + "3. **Forest Plots**: Forest plots provide a simple and intuitive way to visualize many delta-delta (or delta *g*), mini-meta, or regular delta effect sizes at once from multiple different dabest objects without presenting the raw data. See the [Forest Plots tutorial](nbs/tutorials/07-forest_plot.ipynb) for more details.\n", "\n", - "4. **Gridkey**: Users can now represent experimental labels in a ‘gridkey’ table. This can be accessed with the `gridkey` parameter in the `.plot()` method. See the gridkey section in the [Plot Aesthetics tutorial](../tutorials/09-plot_aesthetics.html) for more details.\n", + "4. **Gridkey**: Users can now represent experimental labels in a ‘gridkey’ table. This can be accessed with the `gridkey` parameter in the `.plot()` method. See the gridkey section in the [Plot Aesthetics tutorial](nbs/tutorials/09-plot_aesthetics.ipynb) for more details.\n", "\n", "5. **Other Visualization Improvements**:\n", " - **Comparing means and effect sizes**: The estimation plots now include three types of customizable visual features to enhance contextualization and comparison of means and effect sizes:\n", @@ -45,7 +45,7 @@ " - **Bars for effect size/s (`contrast_bars`)**: Similar to raw bars, these highlight the effect-size difference between two groups (typically test and control) in the contrast axis. They provide a visual representation of the differences between groups.\n", " - **Summary bands (`reference_band`)**: An optional band or ribbon that can be added to emphasize a specific effect size’s confidence interval that is used as a reference range across the entire contrast axis. Unlike raw and contrast bars, these span horizontally (or vertically if `horizontal=True`) and are not displayed by default.\n", "\n", - " Raw and contrast bars are shown by default. Users can customize these bars and add summary bands as needed. For detailed customization instructions, please refer to the [Plot Aesthetics tutorial](../tutorials/09-plot_aesthetics.html).\n", + " Raw and contrast bars are shown by default. Users can customize these bars and add summary bands as needed. For detailed customization instructions, please refer to the [Plot Aesthetics tutorial](nbs/tutorials/09-plot_aesthetics.ipynb).\n", "\n", " - **Tighter spacing in delta-delta and mini-meta plots**: We have adjusted the spacing of delta-delta and mini-meta plots to reduce whitespace. The new format brings the overall effect size closer to the two-groups effect sizes. In addition, delta-delta plots now have a gap in the zero line to separate the delta-delta from the ∆ effect sizes.\n", "\n", From 1eb7c58998a0782996981fd92e0fdfbb48178d22 Mon Sep 17 00:00:00 2001 From: Jonathan Anns Date: Thu, 27 Mar 2025 14:26:07 +0800 Subject: [PATCH 2/2] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4c7bbb1d..cefd6c3d 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,20 @@ performance improvements. It’s a big one! 2. **Horizontal Plots**: Users can now create horizontal layout plots, providing compact data visualization. This can be achieved by setting `horizontal=True` in the `.plot()` method. See the - [Horizontal Plots tutorial](../tutorials/08-horizontal_plot.html) + [Horizontal Plots tutorial](nbs/tutorials/08-horizontal_plot.ipynb) for more details. 3. **Forest Plots**: Forest plots provide a simple and intuitive way to visualize many delta-delta (or delta *g*), mini-meta, or regular delta effect sizes at once from multiple different dabest objects without presenting the raw data. See the [Forest Plots - tutorial](../tutorials/07-forest_plot.html) for more details. + tutorial](nbs/tutorials/07-forest_plot.ipynb) for more details. 4. **Gridkey**: Users can now represent experimental labels in a ‘gridkey’ table. This can be accessed with the `gridkey` parameter in the `.plot()` method. See the gridkey section in the [Plot - Aesthetics tutorial](../tutorials/09-plot_aesthetics.html) for more - details. + Aesthetics tutorial](nbs/tutorials/09-plot_aesthetics.ipynb) for + more details. 5. **Other Visualization Improvements**: @@ -65,7 +65,7 @@ performance improvements. It’s a big one! Raw and contrast bars are shown by default. Users can customize these bars and add summary bands as needed. For detailed customization instructions, please refer to the [Plot Aesthetics - tutorial](../tutorials/09-plot_aesthetics.html). + tutorial](nbs/tutorials/09-plot_aesthetics.ipynb). - **Tighter spacing in delta-delta and mini-meta plots**: We have adjusted the spacing of delta-delta and mini-meta plots to reduce