Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@josesho
josesho committed Oct 21, 2019
1 parent 67a2b90 commit 1c56992
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Expand Up @@ -77,7 +77,7 @@
# The short X.Y version.
version = '0.2'
# The full version, including alpha/beta/rc tags.
release = '0.2.6'
release = '0.2.7'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/index.rst
View file
Expand Up @@ -19,7 +19,8 @@ Analyze your data with estimation statistics!
News
----
October 2019:
- v0.2.6 released. This release has one new feature (plotting of estimation plot inside any :py:mod:`matplotlib` :py:class:`Axes`; see the section on :ref:`inset_plot` in the :doc:`tutorial`). There are also two bug patches for the handling of bootstrap plotting, and of dependency installation. For more information, see the :doc:`release-notes`.
- v0.2.7 released. A minor bugfix in the handling of wide datasets with unequal Ns in each group. For more information, see the :doc:`release-notes`.
- v0.2.6 released. This release has one new feature (plotting of estimation plot inside any :py:mod:`matplotlib` :py:class:`Axes`; see the section on :ref:`inset_plot` in the :doc:`tutorial`). There are also two bug patches for the handling of bootstrap plotting, and of dependency installation.

September 2019:
- v0.2.5 released. This release addresses two feature requests, and also patches two bugs: one affecting the paired difference CIs, and one involving NaNs in unused/irrelevant columns.
Expand Down
11 changes: 9 additions & 2 deletions docs/source/release-notes.rst
View file
Expand Up @@ -4,10 +4,17 @@
Release Notes
=============

v0.2.6
v0.2.7
------

This release addresses a number of bugs and feature improvements. There are no known breaking changes to the API; hence **all users are strongly encouraged to upgrade to the latest version**.
This release addresses a single bug. There are no known breaking changes to the API; hence **all users are strongly encouraged to upgrade to the latest version**.

Bug-fixes:
- Bug affecting display of Tufte gapped lines in Cumming plots if the supplied :py:mod:`pandas` :py:class:`DataFrame` was in 'wide' format, but did not have equal number of Ns in the groups. (`Issue #79 <https://github.com/ACCLAB/DABEST-python/issues/79>`_)


v0.2.6
------

Feature additions:
- It is now possible to specify a pre-determined :py:mod:`matplotlib` :py:class:`Axes` to create the estimation plot in. See the new section in the tutorial for more information. (`Pull request #73 <https://github.com/ACCLAB/DABEST-python/pull/73>`_; thanks to Adam Nekimken (`@anekimken <https://github.com/anekimken>`_).
Expand Down
44 changes: 22 additions & 22 deletions docs/source/tutorial.rst
View file
Expand Up @@ -19,7 +19,7 @@ Load Libraries
.. parsed-literal::
We're using DABEST v0.2.6
We're using DABEST v0.2.7
Create dataset for demo
Expand Down Expand Up @@ -220,11 +220,11 @@ the comparisons that can be computed.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:00 2019.
The current time is Mon Oct 21 11:29:00 2019.
Effect size(s) with 95% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand Down Expand Up @@ -257,11 +257,11 @@ dataset that indicates the identity of each observation, using the
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:00 2019.
The current time is Mon Oct 21 11:29:00 2019.
Paired effect size(s) with 95% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand All @@ -288,11 +288,11 @@ produced.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:00 2019.
The current time is Mon Oct 21 11:29:00 2019.
Effect size(s) with 90% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand Down Expand Up @@ -325,11 +325,11 @@ Each of these are attributes of the :py:class:`Dabest` object.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:00 2019.
The current time is Mon Oct 21 11:29:00 2019.
The unpaired mean difference between Control 1 and Test 1 is 0.48 [95%CI 0.205, 0.774].
The two-sided p-value of the Mann-Whitney test is 0.00163.
Expand Down Expand Up @@ -361,7 +361,7 @@ As noted in the output, you can use ``.mean_diff.statistical_tests`` to
obtain the p-values and test statistics for all relavant statistical
tests.

You can access the results as a pandas DataFrame as well.
You can access the results as a :py:mod:`pandas` :py:class:`DataFrame` as well.



Expand Down Expand Up @@ -536,11 +536,11 @@ Let's compute the Hedges' g for our comparison.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:01 2019.
The current time is Mon Oct 21 11:29:01 2019.
The unpaired Hedges' g between Control 1 and Test 1 is 1.03 [95%CI 0.317, 1.62].
The two-sided p-value of the Mann-Whitney test is 0.00163.
Expand Down Expand Up @@ -787,11 +787,11 @@ to ``idx`` has more than two data columns.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:24 2019.
The current time is Mon Oct 21 11:29:24 2019.
Effect size(s) with 95% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand All @@ -815,11 +815,11 @@ to ``idx`` has more than two data columns.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:25 2019.
The current time is Mon Oct 21 11:29:25 2019.
The unpaired mean difference between Control 1 and Test 1 is 0.48 [95%CI 0.205, 0.774].
The two-sided p-value of the Mann-Whitney test is 0.00163.
Expand Down Expand Up @@ -879,11 +879,11 @@ complex visualizations and statistics.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:26 2019.
The current time is Mon Oct 21 11:29:26 2019.
Effect size(s) with 95% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand All @@ -907,11 +907,11 @@ complex visualizations and statistics.
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:27 2019.
The current time is Mon Oct 21 11:29:27 2019.
The unpaired mean difference between Control 1 and Test 1 is 0.48 [95%CI 0.205, 0.774].
The two-sided p-value of the Mann-Whitney test is 0.00163.
Expand Down Expand Up @@ -1067,11 +1067,11 @@ When your data is in this format, you will need to specify the ``x`` and
.. parsed-literal::
DABEST v0.2.6
DABEST v0.2.7
=============
Good afternoon!
The current time is Thu Oct 3 17:38:27 2019.
The current time is Mon Oct 21 11:29:27 2019.
Effect size(s) with 95% confidence intervals will be computed for:
1. Test 1 minus Control 1
Expand Down

0 comments on commit 1c56992

Please sign in to comment.