Skip to content

Commit 1d3dc13

Browse files
committed
Updated readme
1 parent f0e306d commit 1d3dc13

2 files changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,23 @@ performance improvements. It’s a big one!
2323
2. **Horizontal Plots**: Users can now create horizontal layout plots,
2424
providing compact data visualization. This can be achieved by
2525
setting `horizontal=True` in the `.plot()` method. See the
26-
[Horizontal Plots tutorial](tutorials/08-horizontal_plot.ipynb) for
27-
more details.
26+
[Horizontal Plots
27+
tutorial](https://acclab.github.io/DABEST-python/tutorials/08-horizontal_plot.html)
28+
for more details.
2829

2930
3. **Forest Plots**: Forest plots provide a simple and intuitive way to
3031
visualize many delta-delta (or delta *g*), mini-meta, or regular
3132
delta effect sizes at once from multiple different dabest objects
3233
without presenting the raw data. See the [Forest Plots
33-
tutorial](tutorials/07-forest_plot.ipynb) for more details.
34+
tutorial](https://acclab.github.io/DABEST-python/tutorials/07-forest_plot.html)
35+
for more details.
3436

3537
4. **Gridkey**: Users can now represent experimental labels in a
3638
‘gridkey’ table. This can be accessed with the `gridkey` parameter
3739
in the `.plot()` method. See the gridkey section in the [Plot
38-
Aesthetics tutorial](tutorials/09-plot_aesthetics.ipynb) for more
39-
details.
40+
Aesthetics
41+
tutorial](https://acclab.github.io/DABEST-python/tutorials/09-plot_aesthetics.html)
42+
for more details.
4043

4144
5. **Other Visualization Improvements**:
4245

@@ -65,7 +68,7 @@ performance improvements. It’s a big one!
6568
Raw and contrast bars are shown by default. Users can customize
6669
these bars and add summary bands as needed. For detailed
6770
customization instructions, please refer to the [Plot Aesthetics
68-
tutorial](tutorials/09-plot_aesthetics.ipynb).
71+
tutorial](https://acclab.github.io/DABEST-python/tutorials/09-plot_aesthetics.html).
6972

7073
- **Tighter spacing in delta-delta and mini-meta plots**: We have
7174
adjusted the spacing of delta-delta and mini-meta plots to reduce

nbs/read_me.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@
3333
"\n",
3434
"1. **Python 3.13 Support**: DABEST now supports Python 3.10—3.13.\n",
3535
"\n",
36-
"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.ipynb) for more details.\n",
36+
"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](https://acclab.github.io/DABEST-python/tutorials/08-horizontal_plot.html) for more details.\n",
3737
"\n",
38-
"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.ipynb) for more details.\n",
38+
"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](https://acclab.github.io/DABEST-python/tutorials/07-forest_plot.html) for more details.\n",
3939
"\n",
40-
"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.ipynb) for more details.\n",
40+
"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](https://acclab.github.io/DABEST-python/tutorials/09-plot_aesthetics.html) for more details.\n",
4141
"\n",
4242
"5. **Other Visualization Improvements**:\n",
4343
" - **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",
4444
" - **Bars for the mean of the observed values (`raw_bars`)**: Colored rectangles that extend from the zero line to the mean of each group's raw data. These bars visually highlight the central tendency of the raw data.\n",
4545
" - **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",
4646
" - **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",
4747
"\n",
48-
" 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.ipynb).\n",
48+
" 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](https://acclab.github.io/DABEST-python/tutorials/09-plot_aesthetics.html).\n",
4949
"\n",
5050
" - **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",
5151
"\n",

0 commit comments

Comments
 (0)