Skip to content

Commit 1a135ad

Browse files
committed
Updating docs, maintainer in setup.py
1 parent f271a49 commit 1a135ad

3 files changed

Lines changed: 19 additions & 14 deletions

File tree

docs/source/about.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,17 @@ Authors
99
--------
1010
DABEST is written in Python by `Joses W. Ho <https://twitter.com/jacuzzijo>`_, with design and input from `Adam Claridge-Chang <https://twitter.com/adamcchang>`_ and other `lab members <https://www.claridgechang.net/people.html>`__.
1111

12+
Additional features in v2023.02.14 were added by `Yixuan Li <https://github.com/LI-Yixuan>`_, `Zinan Lu <https://github.com/Jacobluke->`_ and `Rou Zhang <https://github.com/ZHANGROU-99>`_.
13+
1214
To find out more about the authors’ research, please visit the `Claridge-Chang lab webpage <http://www.claridgechang.net/>`_.
1315

1416
Contributors
1517
------------
1618

19+
- Statistics supervision by Hyungwon Choi
20+
21+
- Alpha testers from the Claridge-Chang lab: `Sangyu Xu <https://github.com/sangyu>`_, `Xianyuan Zhang <https://github.com/XYZfar>`_, `Farhan Mohammad <https://github.com/farhan8igib>`_, Jurga Mituzaitė, Stanislav Ott, Tayfun Tumkaya, Jonathan Anns, Nicole Lee and Yishan Mai.
22+
1723
- DizietAsahi (`DizietAsahi <https://github.com/DizietAsahi>`_) with `PR #86 <https://github.com/ACCLAB/DABEST-python/pull/86>`_: Fix bugs in slopegraph and reference line keyword parsing.
1824

1925
- Adam Li (`@adam2392 <https://github.com/adam2392>`_) with `PR #85 <https://github.com/ACCLAB/DABEST-python/pull/85>`_: Implement `Lq-Likelihood-Ratio-Type Test <https://github.com/alyakin314/lqrt>`_ in statistical output.
@@ -25,6 +31,7 @@ Contributors
2531
- Adam Nekimken (`@anekimken <https://github.com/anekimken>`_) with `PR #73 <https://github.com/ACCLAB/DABEST-python/pull/73>`_: Implement inset axes so estimation plots can be plotted on a pre-determined :py:mod:`matplotlib` :py:class:`Axes` object.
2632

2733

34+
2835
Typography
2936
----------
3037

docs/source/repeatedmeasures.rst

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
Tutorial: Repeated Measures
55
===========================
66

7-
DABEST version 2023.02.14 expands the repertoire of plots for experiments with repeated-measures designs. DABEST now allows the visualization of paired experiments with one control and multiple test
8-
groups, as well as repeated measurements of the same group. This is an improved version of paired data plotting in previous versions, which only supported computations involving one test group and one control group.
7+
DABEST version 2023.02.14 expands the repertoire of plots for experiments with repeated-measures designs. DABEST now allows for the calculation and plotting of effect sizes for:
98

10-
The repeated-measures function supports the calculation of effect sizes for
11-
paired data, either based on sequential comparisons (group i vs group i + 1)
12-
or baseline comparisons (control vs group i). To use these features,
13-
you can simply declare the argument ``paired = "sequential"`` or ``paired = "baseline"``
14-
correspondingly while running ``dabest.load()``. As in the previous version, you must also pass a column in the dataset that indicates the identity of each observation, using the
15-
``id_col`` keyword.
9+
- Comparing each group to a shared control (control vs. group i; ``baseline``)
10+
- Comparing each measurement to the one directly preceding it (group i vs group i+1; ``sequential``)
11+
12+
This is an improved version of paired data plotting in previous versions, which only supported computations involving one test group and one control group.
13+
14+
To use these features, you can simply declare the argument ``paired = "sequential"`` or ``paired = "baseline"`` correspondingly while running ``dabest.load()``. As in the previous version, you must also pass a column in the dataset that indicates the identity of each observation, using the ``id_col`` keyword.
1615

1716
**(Please note that** ``paired = True`` **and** ``paired = False`` **are no longer valid in v2023.02.14)**
1817

@@ -253,9 +252,9 @@ Both Gardner-Altman and Cumming plots support this.
253252
254253
.. image:: _images/tutorial_33_0.png
255254

256-
You can also create repeated-measures plots with multiple test groups.In
255+
You can also create repeated-measures plots with multiple test groups. In
257256
this case, declaring ``paired`` to be ``sequential`` or ``baseline`` will
258-
generate different results.
257+
generate the same slopegraph, reflecting the repeated-measures experimental design, but different contrast plots, to show the ``sequential`` or ``baseline`` comparison:
259258

260259
.. code-block:: python3
261260
:linenos:
@@ -362,8 +361,7 @@ generate different results.
362361
363362
.. image:: _images/tutorial_104_0.png
364363

365-
Same as that for unpaired data, DABEST empowers you to perform complex
366-
visualizations and statistics for paired data as well.
364+
As with unpaired data, DABEST empowers you to perform complex visualizations and statistics for paired data as well.
367365

368366
.. code-block:: python3
369367
:linenos:

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
name='dabest',
3333
author='Joses W. Ho',
3434
author_email='joseshowh@gmail.com',
35-
maintainer='Joses W. Ho',
36-
maintainer_email='joseshowh@gmail.com',
35+
maintainer='Adam Claridge-Chang',
36+
maintainer_email='estimationstats@gmail.com',
3737
version='2023.02.14',
3838
description=DESCRIPTION,
3939
long_description=LONG_DESCRIPTION,

0 commit comments

Comments
 (0)