You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: nbs/read_me.ipynb
+10-9Lines changed: 10 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -33,22 +33,24 @@
33
33
"\n",
34
34
"1. **Python 3.13 Support**: DABEST now supports Python 3.10-3.13.\n",
35
35
"\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",
37
37
"\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",
39
39
"\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",
42
44
"\n",
43
45
" - **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",
44
46
"\n",
45
47
" - **Delta-delta Effect Sizes for Proportion Plots**: Delta-delta effect sizes for proportion plots are now available.\n",
46
48
"\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",
48
50
"\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",
50
52
"\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",
52
54
"\n",
53
55
" - **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",
54
56
"\n",
@@ -57,8 +59,7 @@
57
59
" - **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",
" - **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",
63
64
"\n",
64
65
" - **Terminology Updates**: We have made several updates to the documentation and terminology to improve clarity and consistency. For example:\n",
0 commit comments