Skip to content

Commit e341125

Browse files
committed
Updated Readme and tutorial pages
1 parent cb5dc2d commit e341125

11 files changed

Lines changed: 290 additions & 287 deletions

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,35 @@ includes performance improvements. It’s a big one!
2222

2323
2. **Horizontal Plots**: This new feature allows users to create
2424
horizontal plots instead of the regular vertical plots, providing a
25-
more compact visualization of data.
25+
more compact visualization of data. This can be utilized by setting
26+
`horizontal=True` in the `plot()` method. See the [Horizontal
27+
Plots](../tutorials/08-horizontal_plot.html) tutorial for more
28+
details.
2629

2730
3. **Forest Plots**: This new feature allows users to create forest
2831
plots! Forest plots provide a simple and intuitive way to visualize
2932
many delta-delta (or Deltas’ g) or mini-meta effect sizes at once
3033
from multiple different dabest objects without presenting the raw
31-
data.
34+
data. See the [Forest Plots](../tutorials/07-forest_plot.html)
35+
tutorial for more details.
3236

33-
4. **Aesthetic Updates**: We have made several aesthetic improvements
37+
4. **Gridkey**: This new feature allows users to create a gridkey to
38+
represent the labels of the groups in the plot. This can be utilized
39+
with the `gridkey_rows` argument in the `plot()` method. See the
40+
gridkey section in the [Plot
41+
Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more
42+
details.
43+
44+
5. **Aesthetic Updates**: We have made several aesthetic improvements
3445
to the plots, including:
3546

3647
- **Swarm, Contrast, and Summary bars**: We have added bars to
3748
better highlight the various groups and their differences. These
3849
bars can be customized to suit the user’s needs. The swarm and
3950
contrast bars are provided by default, while the summary bars can
40-
be added by the user.
51+
be added by the user. See the relevant sections in the [Plot
52+
Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for
53+
more details.
4154

4255
- **Delta-Delta Plots**: We have modified the delta-delta plot
4356
format to be more compact and easier to read. The new format
@@ -50,13 +63,15 @@ includes performance improvements. It’s a big one!
5063

5164
- **Mini-Meta Plots**: We have modified the mini-meta plot format to
5265
be more compact and easier to read. The new format brings the
53-
mini-meta effect size closer to the regular effect sizes
66+
mini-meta effect size closer to the regular effect sizes.
5467

5568
- **Proportion Plots Sample Sizes**: We have updated the proportion
56-
plots to show sample sizes for each group.
69+
plots to show sample sizes for each group. These can be toggled on
70+
or off via the `prop_sample_counts` parameter.
5771

5872
- **Effect Size Lines for Paired Plots**: Effect size lines for
59-
paired plots are now available.
73+
paired plots are now available. These can be toggled on or off via
74+
the `es_paired_lines` parameter.
6075

6176
- **Baseline Error Curves**: Plots now include a baseline error dot
6277
and curve to show the error of the baseline/control group. By
@@ -74,7 +89,7 @@ includes performance improvements. It’s a big one!
7489
modifies the two-group swarmplots to have empty circles for the
7590
control group and filled circles for the experimental group.
7691

77-
5. **Miscellaneous Improvements & Adjustments**
92+
6. **Miscellaneous Improvements & Adjustments**
7893

7994
- **Numba for Speed Improvements**: We have included Numba to speed
8095
up the various calculations in DABEST. This should make the

nbs/read_me.ipynb

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,24 @@
3333
"\n",
3434
"1. **Python 3.13 Support**: DABEST now supports Python 3.10-3.13.\n",
3535
"\n",
36-
"1. **Horizontal Plots**: This new feature allows users to create horizontal plots instead of the regular vertical plots, providing a more compact visualization of data.\n",
36+
"2. **Horizontal Plots**: This new feature allows users to create horizontal plots instead of the regular vertical plots, providing a more compact visualization of data. This can be utilized by setting `horizontal=True` in the `plot()` method. See the [Horizontal Plots](../tutorials/08-horizontal_plot.html) tutorial for more details.\n",
3737
"\n",
38-
"2. **Forest Plots**: This new feature allows users to create forest plots! Forest plots provide a simple and intuitive way to visualize many delta-delta (or Deltas' g) or mini-meta effect sizes at once from multiple different dabest objects without presenting the raw data.\n",
38+
"3. **Forest Plots**: This new feature allows users to create forest plots! Forest plots provide a simple and intuitive way to visualize many delta-delta (or Deltas' g) or mini-meta effect sizes at once from multiple different dabest objects without presenting the raw data. See the [Forest Plots](../tutorials/07-forest_plot.html) tutorial for more details.\n",
3939
"\n",
40-
"3. **Aesthetic Updates**: We have made several aesthetic improvements to the plots, including:\n",
41-
" - **Swarm, Contrast, and Summary bars**: We have added bars to better highlight the various groups and their differences. These bars can be customized to suit the user's needs. The swarm and contrast bars are provided by default, while the summary bars can be added by the user.\n",
40+
"4. **Gridkey**: This new feature allows users to create a gridkey to represent the labels of the groups in the plot. This can be utilized with the `gridkey_rows` argument in the `plot()` method. See the gridkey section in the [Plot Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more details.\n",
41+
"\n",
42+
"5. **Aesthetic Updates**: We have made several aesthetic improvements to the plots, including:\n",
43+
" - **Swarm, Contrast, and Summary bars**: We have added bars to better highlight the various groups and their differences. These bars can be customized to suit the user's needs. The swarm and contrast bars are provided by default, while the summary bars can be added by the user. See the relevant sections in the [Plot Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more details.\n",
4244
" \n",
4345
" - **Delta-Delta Plots**: We have modified the delta-delta plot format to be more compact and easier to read. The new format brings the delta-delta (or Deltas' g) effect size closer to the regular effect sizes. In addition, a gap has been added to the zeroline to separate the delta-delta and regular effect sizes.\n",
4446
"\n",
4547
" - **Delta-delta Effect Sizes for Proportion Plots**: Delta-delta effect sizes for proportion plots are now available.\n",
4648
" \n",
47-
" - **Mini-Meta Plots**: We have modified the mini-meta plot format to be more compact and easier to read. The new format brings the mini-meta effect size closer to the regular effect sizes\n",
49+
" - **Mini-Meta Plots**: We have modified the mini-meta plot format to be more compact and easier to read. The new format brings the mini-meta effect size closer to the regular effect sizes.\n",
4850
"\n",
49-
" - **Proportion Plots Sample Sizes**: We have updated the proportion plots to show sample sizes for each group.\n",
51+
" - **Proportion Plots Sample Sizes**: We have updated the proportion plots to show sample sizes for each group. These can be toggled on or off via the `prop_sample_counts` parameter.\n",
5052
"\n",
51-
" - **Effect Size Lines for Paired Plots**: Effect size lines for paired plots are now available.\n",
53+
" - **Effect Size Lines for Paired Plots**: Effect size lines for paired plots are now available. These can be toggled on or off via the `es_paired_lines` parameter.\n",
5254
"\n",
5355
" - **Baseline Error Curves**: Plots now include a baseline error dot and curve to show the error of the baseline/control group. By default, the dot is shown, while the curve can be added by the user (via the `show_baseline_ec` parameter).\n",
5456
"\n",
@@ -57,8 +59,7 @@
5759
" - **Empty Circle Color Palette**: A new swarmplot color palette modification is available for unpaired plots via the `empty_circle` parameter in the `plot()` method. This option modifies the two-group swarmplots to have empty circles for the control group and filled circles for the experimental group.\n",
5860
"\n",
5961
"\n",
60-
"\n",
61-
"4. **Miscellaneous Improvements & Adjustments**\n",
62+
"6. **Miscellaneous Improvements & Adjustments**\n",
6263
" - **Numba for Speed Improvements**: We have included Numba to speed up the various calculations in DABEST. This should make the calculations faster and more efficient. Importing DABEST may take a little longer than before, and a progress bar will appear during the import process to show the calculations being performed. Once imported, loading and plotting data should now be faster.\n",
6364
" \n",
6465
" - **Terminology Updates**: We have made several updates to the documentation and terminology to improve clarity and consistency. For example:\n",

nbs/tutorials/01-basics.ipynb

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

nbs/tutorials/02-two_group.ipynb

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

nbs/tutorials/03-shared_control_and_repeated_measures.ipynb

Lines changed: 24 additions & 24 deletions
Large diffs are not rendered by default.

nbs/tutorials/04-proportion_plot.ipynb

Lines changed: 70 additions & 70 deletions
Large diffs are not rendered by default.

nbs/tutorials/05-mini_meta.ipynb

Lines changed: 15 additions & 15 deletions
Large diffs are not rendered by default.

nbs/tutorials/06-delta_delta.ipynb

Lines changed: 29 additions & 29 deletions
Large diffs are not rendered by default.

nbs/tutorials/07-forest_plot.ipynb

Lines changed: 18 additions & 31 deletions
Large diffs are not rendered by default.

nbs/tutorials/08-horizontal_plot.ipynb

Lines changed: 21 additions & 21 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)