Skip to content

Commit 2195681

Browse files
committed
Updated naming of plot arguments and fix bugs with some argument functionalities
> Add error if ci_type is not given as 'bca' or 'pct' > fix group_summaries such that none can now be provided in case you dont want to show them > fix barplot errorbar to hide group_summaries if errorbar is selected and removed 'ci' argument from plotter as it doesnt make sense and was only used for the barplot_kwargs errorbar >Added ability to add 'width' to barplot_kwargs so can use bar_width or the barplot_kwargs['width'] >Added ci_type argument to tutorial and also updated a warning message ('pct' instead of 'percentile') >Fixed warning message when paired data with no color_col raises warning about legend >Fix raw tick label fontsize if counts are not shown >add title functionality to plots already embedded in a figure (as a subplot) >added a raw_alpha argument to fit with the contrast_alpha argument >change naming of parameters to be consistent. General parameters are now referred to via 'raw' or 'contrast' (e.g., raw_marker_size and contrast_marker_size) >updated tests and tutorials to reflect the changes and updated naming
1 parent 281338d commit 2195681

36 files changed

Lines changed: 1238 additions & 1036 deletions

README.md

Lines changed: 55 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -20,68 +20,61 @@ performance improvements. It’s a big one!
2020

2121
1. **Python 3.13 Support**: DABEST now supports Python 3.10-3.13.
2222

23-
2. **Horizontal Plots**: This new feature allows users to create
24-
horizontal plots instead of the regular vertical plots, providing a
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.
29-
30-
3. **Forest Plots**: This new feature allows users to create forest
31-
plots! Forest plots provide a simple and intuitive way to visualize
32-
many delta-delta (or Deltas’ g) or mini-meta effect sizes at once
33-
from multiple different dabest objects without presenting the raw
34-
data. See the [Forest Plots](../tutorials/07-forest_plot.html)
35-
tutorial for more details.
36-
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
23+
2. **Horizontal Plots**: Users can now create horizontal layout plots,
24+
providing compact data visualization. This can be achieved by
25+
setting `horizontal=True` in the `plot()` method. See the
26+
[Horizontal Plots](../tutorials/08-horizontal_plot.html) tutorial
27+
for more details.
28+
29+
3. **Forest Plots**: Forest plots provide a simple and intuitive way to
30+
visualize many delta-delta (or Deltas’ g), mini-meta, or regular
31+
delta effect sizes at once from multiple different dabest objects
32+
without presenting the raw data. See the [Forest
33+
Plots](../tutorials/07-forest_plot.html) tutorial for more details.
34+
35+
4. **Gridkey**: Users can now represent their experimental labels in a
36+
gridkey format. This can be accessed with the `gridkey` argument in
37+
the `plot()` method. See the gridkey section in the [Plot
4138
Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for more
4239
details.
4340

4441
5. **Aesthetic Updates**: We have made several aesthetic improvements
4542
to the plots, including:
4643

47-
- **Swarm, Contrast, and Summary bars**: We have added bars to
48-
better highlight the various groups and their differences. These
49-
bars can be customized to suit the user’s needs. The swarm and
50-
contrast bars are provided by default, while the summary bars can
51-
be added by the user. See the relevant sections in the [Plot
44+
- **Raw, Contrast, and Summary bars**: We added bars highlighting
45+
the various groupsdifferences. These bars can be customized to
46+
suit the user’s needs. Raw and contrast bars are provided by
47+
default, summary bars can be added by the user. See the relevant
48+
sections in the [Plot
5249
Aesthetics](../tutorials/09-plot_aesthetics.html) tutorial for
5350
more details.
5451

55-
- **Delta-Delta Plots**: We have modified the delta-delta plot
56-
format to be more compact and easier to read. The new format
57-
brings the delta-delta (or Deltas’ g) effect size closer to the
58-
regular effect sizes. In addition, a gap has been added to the
52+
- **Delta-Delta and Mini-Meta Plots**: We have adjusted the spacing
53+
of delta-delta and mini-meta plots to reduce whitespace. The new
54+
format brings the added effect size closer to the regular effect
55+
sizes. In addition, delta-delta plots now have a gap in the
5956
zeroline to separate the delta-delta and regular effect sizes.
6057

61-
- **Delta-delta Effect Sizes for Proportion Plots**: Delta-delta
62-
effect sizes for proportion plots are now available.
63-
64-
- **Mini-Meta Plots**: We have modified the mini-meta plot format to
65-
be more compact and easier to read. The new format brings the
66-
mini-meta effect size closer to the regular effect sizes.
58+
- **Delta-Delta Effect Sizes for Proportion Plots**: Delta-delta
59+
experimental plotting now supports binary data.
6760

68-
- **Proportion Plots Sample Sizes**: We have updated the proportion
69-
plots to show sample sizes for each group. These can be toggled on
70-
or off via the `prop_sample_counts` parameter.
61+
- **Proportion Plots Sample Sizes**: The sample size of each binary
62+
option for each group can now be displayed. These can be toggled
63+
on or off via the `prop_sample_counts` parameter.
7164

72-
- **Effect Size Lines for Paired Plots**: Effect size lines for
73-
paired plots are now available. These can be toggled on or off via
74-
the `es_paired_lines` parameter.
65+
- **Effect Size Lines for Paired Plots**: Paired plots now display
66+
lines linking the effect sizes within a group together in the
67+
contrast axes. These can be toggled on or off via the
68+
`contrast_paired_lines` parameter.
7569

76-
- **Baseline Error Curves**: Plots now include a baseline error dot
77-
and curve to show the error of the baseline/control group. By
78-
default, the dot is shown, while the curve can be added by the
79-
user (via the `show_baseline_ec` parameter).
70+
- **Baseline Error Curves**: Baseline error dot and curve are now
71+
available to represent the baseline/control group in the contrast
72+
axes. The dot is shown by default, while the curve can be toggled
73+
on/off by the user (via the `show_baseline_ec` parameter).
8074

81-
- **Delta Text**: There is now an option to display delta text on
82-
the contrast axes. It displays the effect size of the contrast
83-
group relative to the reference group. This can be toggled on or
84-
off via the `delta_text` parameter. It is on by default.
75+
- **Delta Text**: Effect size deltas are now displayed as text next
76+
to their respective effect size. This can be toggled on or off via
77+
the `delta_text` parameter.
8578

8679
- **Empty Circle Color Palette**: A new swarmplot color palette
8780
modification is available for unpaired plots via the
@@ -92,26 +85,31 @@ performance improvements. It’s a big one!
9285
6. **Miscellaneous Improvements & Adjustments**
9386

9487
- **Numba for Speed Improvements**: We have included Numba to speed
95-
up the various calculations in DABEST. This should make the
96-
calculations faster and more efficient. Importing DABEST may take
97-
a little longer than before, and a progress bar will appear during
98-
the import process to show the calculations being performed. Once
99-
imported, loading and plotting data should now be faster.
88+
up the various calculations in DABEST. Precalculations will be
89+
performed during import, which will help speed up the subsequent
90+
loading and plotting of data.
10091

10192
- **Terminology Updates**: We have made several updates to the
10293
documentation and terminology to improve clarity and consistency.
10394
For example:
10495

96+
- Plot arguments have been adjusted to bring more clarity and
97+
consistency in naming. Arguments relating to the rawdata plot
98+
axis will now be typically referred to with ‘raw’ while
99+
arguments relating to the contrast axis will be referred to with
100+
‘contrast’. For example, ‘raw_label’ replaces ‘swarm_label’ and
101+
‘bar_label’. The various kwargs relating to each different type
102+
of plot (e.g., swarmplot_kwargs) remain unchanged.
105103
- The method to utilise the Deltas’ g effect size is now via the
106-
`.hedges_g.plot()` method now rather than creating a whole new
107-
`Delta_g` object as before. The functionality remains the same,
108-
it plots hedges_g effect sizes and then the Deltas’ g effect
109-
size alongside these (if a delta-delta experiment was loaded
104+
.hedges_g.plot() method rather than creating a whole new Delta_g
105+
object as before. The functionality remains the same, it plots
106+
hedges_g effect sizes and then the Deltas’ g effect size
107+
alongside these (if a delta-delta experiment was loaded
110108
correctly).
111109

112110
- **Updated Tutorial Pages**: We have updated the tutorial pages to
113111
reflect the new features and changes. The tutorial pages are now
114-
more comprehensive and hopefully more intuitive!
112+
more comprehensive and (hopefully!) more intuitive!
115113

116114
- **Results Dataframe for Delta-Delta and Mini-Meta Plots**: A
117115
results dataframe can now be extracted for both the delta-delta

0 commit comments

Comments
 (0)