Skip to content

Commit 059e85d

Browse files
committed
update docs
1 parent 1d5f398 commit 059e85d

5 files changed

Lines changed: 25 additions & 7 deletions

File tree

docs/source/about.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ About
77

88
Authors
99
--------
10-
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.
10+
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

1212
To find out more about the authors’ research, please visit the `Claridge-Chang lab webpage <http://www.claridgechang.net/>`_.
1313

docs/source/citation.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _Citing DABEST:
2+
3+
4+
=============
5+
Citing DABEST
6+
=============
7+
8+
If your publication features a graphic generated with this software library, please cite the following publication.
9+
10+
**Moving beyond P values: Everyday data analysis with estimation plots**
11+
Joses Ho, Tayfun Tumkaya, Sameer Aryal, Hyungwon Choi, Adam Claridge-Chang
12+
13+
`Nature Methods` 2019, 1548-7105. `doi:10.1038/s41592-019-0470-3 <https://doi.org/10.1038/s41592-019-0470-3>`__
14+
15+
`Free-to-view PDF <https://rdcu.be/bHhJ4>`__
16+
17+
`Paywalled publisher site <https://www.nature.com/articles/s41592-019-0470-3>`__

docs/source/getting-started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Getting Started
88
Requirements
99
------------
1010

11-
Python 3.7 is strongly recommended. DABEST has also been tested with Python 3.5 and 3.6.
11+
Python 3.8 is strongly recommended. DABEST has also been tested with Python 3.5, 3.6, and 3.7.
1212

1313
In addition, the following packages are also required (listed with their minimal versions):
1414

@@ -17,7 +17,7 @@ In addition, the following packages are also required (listed with their minimal
1717
* `matplotlib 3.0 <https://www.matplotlib.org>`_
1818
* `pandas 0.25.3 <https://pandas.pydata.org>`_
1919
* `seaborn 0.9 <https://seaborn.pydata.org>`_
20-
* `lqrt 0.3.2 <https://github.com/alyakin314/lqrt>`_
20+
* `lqrt 0.3 <https://github.com/alyakin314/lqrt>`_
2121

2222
To obtain these package dependencies easily, it is highly recommended to download the `Anaconda <https://www.continuum.io/downloads>`_ distribution of Python.
2323

docs/source/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Analyze your data with estimation statistics!
1919
News
2020
----
2121
January 2020:
22-
- v0.3.0 released. Approximate permutation tests have been added, and are now the default p-values reported in the textual output. The LqRT tests were also refactored to a user-callable property.
22+
- v0.3.0 released. Approximate permutation tests have been added, and are now the default p-values reported in the textual output. The LqRT tests were also refactored to a user-callable property. For more information, see the :doc:`release-notes`.
2323

2424
December 2019:
25-
- v0.2.8 released. This release adds the `Lq-Likelihood-Ratio-Type Test <https://github.com/alyakin314/lqrt>`_ in the statistical output, and also a bugfix for slopegraph and reference line keyword parsing. For more information, see the :doc:`release-notes`.
25+
- v0.2.8 released. This release adds the `Lq-Likelihood-Ratio-Type Test <https://github.com/alyakin314/lqrt>`_ in the statistical output, and also a bugfix for slopegraph and reference line keyword parsing.
2626

2727
October 2019:
2828
- v0.2.7 released. A minor bugfix in the handling of wide datasets with unequal Ns in each group.
@@ -47,7 +47,7 @@ Contents
4747
--------
4848

4949
.. toctree::
50-
:maxdepth: 2
50+
:maxdepth: 1
5151

5252
robust-beautiful
5353
bootstraps
@@ -56,3 +56,4 @@ Contents
5656
release-notes
5757
api
5858
about
59+
citation

docs/source/tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1382,7 +1382,7 @@ Applying style sheets
13821382

13831383
*Implemented in v0.2.0*.
13841384

1385-
``dabest`` can now apply `matplotlib style
1385+
``dabest`` can apply `matplotlib style
13861386
sheets <https://matplotlib.org/tutorials/introductory/customizing.html>`__
13871387
to estimation plots. You can refer to this
13881388
`gallery <https://matplotlib.org/3.0.3/gallery/style_sheets/style_sheets_reference.html>`__

0 commit comments

Comments
 (0)