Skip to content

Commit 8d76edd

Browse files
committed
Updates readme.md with the release notification
1 parent cfe5eb8 commit 8d76edd

3 files changed

Lines changed: 23 additions & 19 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66
[![Free-to-view citation](https://zenodo.org/badge/DOI/10.1038/s41592-019-0470-3.svg)](https://rdcu.be/bHhJ4)
77
[![License](https://img.shields.io/badge/License-BSD%203--Clause--Clear-orange.svg)](https://spdx.org/licenses/BSD-3-Clause-Clear.html)
88

9-
## Upcoming Version Update
9+
## Version Update
1010

11-
On 20 March 2023, we will be officially releasing **DABEST v2023.02.14 for Python**. This version provides exciting new features:
11+
**DABEST v2023.02.14** for Python is now released!
12+
13+
This new version provides the following new features:
1214

13-
1. **Repeated measures.** Augments the prior function for plotting (independent) multiple test groups versus a shared control; it can now do the same for repeated-measures experimental design. Together, these two methods can be used to replace both flavors of the 1-way ANOVA with an estimation analysis.
15+
1. [**Repeated measures.**](https://acclab.github.io/DABEST-python-docs/repeatedmeasures.html) Augments the prior function for plotting (independent) multiple test groups versus a shared control; it can now do the same for repeated-measures experimental design. Together, these two methods can be used to replace both flavors of the 1-way ANOVA with an estimation analysis.
1416

15-
2. **Proportional data.** Generates proportional bar plots, proportional differences, and calculates Cohen's h. Also enables plotting Sankey diagrams for paired binary data. This is the estimation graphic equivalent to a bar chart with Fisher's exact test.
17+
2. [**Proportional data.**](https://acclab.github.io/DABEST-python-docs/proportion-plot.html) Generates proportional bar plots, proportional differences, and calculates Cohen's h. Also enables plotting Sankey diagrams for paired binary data. This is the estimation graphic equivalent to a bar chart with Fisher's exact test.
1618

17-
3. **The ∆∆ plot.** Calculates the delta-delta (∆∆) for 2 × 2 experimental design and plots the four groups with their relevant effect sizes. This design can be used as a replacement for the 2 × 2 ANOVA.
19+
3. [**The ∆∆ plot.**](https://acclab.github.io/DABEST-python-docs/deltadelta.html) Calculates the delta-delta (∆∆) for 2 × 2 experimental design and plots the four groups with their relevant effect sizes. This design can be used as a replacement for the 2 × 2 ANOVA.
1820

19-
4. **Mini-meta.** Calculates and plots a weighted delta (∆) for meta-analysis of experimental replicates. Useful for summarizing data from multiple replicated experiments, for example by different scientists in the same lab or the same scientist at different times. When the observed values are known (and share a common metric), this function makes such meta-analysis convenient.
21+
4. [**Mini-meta.**](https://acclab.github.io/DABEST-python-docs/minimetadelta.html) Calculates and plots a weighted delta (∆) for meta-analysis of experimental replicates. Useful for summarizing data from multiple replicated experiments, for example by different scientists in the same lab or the same scientist at different times. When the observed values are known (and share a common metric), this function makes such meta-analysis convenient.
2022

21-
Prior to the official update, users interested in these features are invited to download the v0.4dev branch. After 20 March 2023, the new version in the main branch will be the one we recommend for all users.
23+
We recommend all users update to the new version. Please see the [updated documentation](https://acclab.github.io/DABEST-python-docs/) for more details and relevant tutorials.
2224

2325

2426
## Contents

docs/source/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Update
1313

1414
Briefly, this release introduces several new functions:
1515

16-
- Additional plotting functions for repeated measures experimental designs
17-
- Calculating of Cohen's *h* and proportional plots for binary data
18-
- Calculating and plotting delta-deltas for 2x2 experimental designs
19-
- Calculating and plotting of weighted deltas for mini-meta-analysis of experimental replicates
16+
- Additional plotting functions for repeated measures experimental designs (:doc:`repeatedmeasures`)
17+
- Calculating of Cohen's *h* and proportional plots for binary data (:doc:`proportion-plot`)
18+
- Calculating and plotting delta-deltas for 2x2 experimental designs (:doc:`deltadelta`)
19+
- Calculating and plotting of weighted deltas for mini-meta-analysis of experimental replicates (:doc:`minimetadelta`)
2020

2121
Refer to :doc:`release-notes` for full details.
2222

docs/source/release-notes.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,21 @@ v2023.02.14
99

1010
This release introduces several new functions:
1111

12-
- **Repeated measures**: Augments the prior function for plotting (independent) multiple test groups versus a shared control (``"baseline"``); it can now do the same for repeated-measures experimental designs (``"sequential"``). Thus, together, these two methods can be used to replace both flavors of the 1-way ANOVA with an estimation analysis.
12+
- **Repeated measures**: Augments the prior function for plotting (independent) multiple test groups versus a shared control (``"baseline"``); it can now do the same for repeated-measures experimental designs (``"sequential"``). Thus, together, these two methods can be used to replace both flavors of the 1-way ANOVA with an estimation analysis.
1313
- **Deprecation notice:** The ``paired`` argument for ``dabest.load()`` is no longer boolean, and now only accepts ``"baseline"`` or ``"sequential"`` as a string.
14-
- **Proportional data**: Generates proportional bar plots, proportional differences, and calculates Cohen's *h*. Also enables plotting Sankey diagrams for paired binary data. This is the estimation equivalent to a bar chart with Fischer's exact test.
15-
- **The ∆∆ plot**: Calculates the delta-delta (∆∆) for 2 × 2 experimental designs and plots the four groups with their relevant effect sizes. This design can be used as a replacement for the 2 × 2 ANOVA.
16-
- **Mini-meta**: Calculates and plots a weighted delta (∆) for meta-analysis of experimental replicates. Useful for summarizing data from multiple replicated experiments, for example by different scientists in the same lab, or the same scientist at different times. When the observed values are known (and share a common metric), this makes meta-analysis available as a routinely accessible tool.
14+
- **Proportional data**: Generates proportional bar plots, proportional differences, and calculates Cohen's *h*. Also enables plotting Sankey diagrams for paired binary data. This is the estimation equivalent to a bar chart with Fischer's exact test.
15+
- **The ∆∆ plot**: Calculates the delta-delta (∆∆) for 2 × 2 experimental designs and plots the four groups with their relevant effect sizes. This design can be used as a replacement for the 2 × 2 ANOVA.
16+
- **Mini-meta**: Calculates and plots a weighted delta (∆) for meta-analysis of experimental replicates. Useful for summarizing data from multiple replicated experiments, for example by different scientists in the same lab, or the same scientist at different times. When the observed values are known (and share a common metric), this makes meta-analysis available as a routinely accessible tool.
1717

18-
Please read the updated tutorials if you wish to use any of the above functions:
18+
Please read the updated tutorials if you wish to use the above functions:
1919

20-
:doc:`repeatedmeasures`
20+
:doc:`repeatedmeasures`
2121

22-
:doc:`proportion-plot`
22+
:doc:`proportion-plot`
2323

24-
:doc:`minimetadelta`
24+
:doc:`deltadelta`
25+
26+
:doc:`minimetadelta`
2527

2628
v0.3.1
2729
------

0 commit comments

Comments
 (0)