Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josesho committed Dec 23, 2019
1 parent 73f45b4 commit d8dd4bf
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
7 changes: 6 additions & 1 deletion docs/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,17 @@ To find out more about the authors’ research, please visit the `Claridge-Chang
Contributors
------------

- 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.

- 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.

- Mason Malone (`@MasonM <https://github.com/MasonM>`_) with `PR #30 <https://github.com/ACCLAB/DABEST-python/pull/30>`_: Fix plot error when effect size is 0.

- Matthew Edwards (`@mje-nz <https://github.com/mje-nz>`_) with `PR #71 <https://github.com/ACCLAB/DABEST-python/pull/30>`_: Specify dependencies correctly in ``setup.py``.

- 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.


Typography
----------

Expand All @@ -31,7 +36,7 @@ License

The DABEST package in Python is licenced under the `BSD 3-clause Clear License <https://choosealicense.com/licenses/bsd-3-clause-clear/>`_.

Copyright (c) 2016-2019, Joses W. Ho
Copyright (c) 2016-2020, Joses W. Ho
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
5 changes: 3 additions & 2 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ Requirements

Python 3.7 is strongly recommended. DABEST has also been tested with Python 3.5 and 3.6.

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

* `numpy 1.15 <https://www.numpy.org>`_
* `scipy 1.2 <https://www.scipy.org>`_
* `matplotlib 3.0 <https://www.matplotlib.org>`_
* `pandas 0.24 <https://pandas.pydata.org>`_
* `pandas 0.25.3 <https://pandas.pydata.org>`_
* `seaborn 0.9 <https://seaborn.pydata.org>`_
* `lqrt 0.3.2 <https://github.com/alyakin314/lqrt>`_

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

Expand Down
13 changes: 13 additions & 0 deletions docs/source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@
Release Notes
=============

v0.2.8
------

This release fixes minor bugs, and implements a new statistical test. There are no known breaking changes to the API; hence **all users are strongly encouraged to upgrade to the latest version**.

Feature Additions:
- Implement `Lq-Likelihood-Ratio-Type Test <https://github.com/alyakin314/lqrt>`_ in statistical output with `PR #85 <https://github.com/ACCLAB/DABEST-python/pull/85>`_; thanks to Adam Li (`@adam2392 <https://github.com/adam2392>`_).

Bug-fixes:
- - Fix bugs in slopegraph and reference line keyword parsing with `PR #86 <https://github.com/ACCLAB/DABEST-python/pull/86>`_; thanks to DizietAsahi (`DizietAsahi <https://github.com/DizietAsahi>`_).



v0.2.7
------

Expand Down

0 comments on commit d8dd4bf

Please sign in to comment.