Skip to content

Commit

Permalink
adjust readme, changelog, some cleaning, build doc
Browse files Browse the repository at this point in the history
  • Loading branch information
trevismd committed Jun 20, 2023
1 parent 39247af commit 4766703
Show file tree
Hide file tree
Showing 32 changed files with 1,126 additions and 1,992 deletions.
25 changes: 20 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
## v0.5
### v0.5.1
- Fix keeping annotation with reduced ylim (Issue [#91]
(https://github.com/trevismd/statannotations/issues/91))
## v0.6
### v0.6.0
#### Features
- Add option to skip annotation of non-significant results
(PR [#95](https://github.com/trevismd/statannotations/pull/95) by
[sepro](https://github.com/sepro))

#### Fixes
- Fix keeping annotation with reduced ylim (
PR [#116](https://github.com/trevismd/statannotations/issues/116) by
[amkorb](https://github.com/amkorb))

#### Additional testing and documentation:
- PR [#84](https://github.com/trevismd/statannotations/pull/84) by
[JasonMendoza2008 ](https://github.com/JasonMendoza2008)
- PR [#86](https://github.com/trevismd/statannotations/pull/86) by
[mbhall88](https://github.com/mbhall88)
- PR [#117](https://github.com/trevismd/statannotations/pull/117) by
[tathey1](https://github.com/tathey1)

### v0.5.0
## v0.5.0
- Add scipy's Brunner-Munzel test
- Fix applying statannotations for non-string group labels (Issue
[#65](https://github.com/trevismd/statannotations/issues/65))
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,15 @@ corresponding branch).
- Optionally, custom p-values can be given as input.
In this case, no statistical test is performed, but **corrections for
multiple testing can be applied.**
- It is also possible to hide non statistically significant annotations
- Any text can be used as annotation
- And various fixes (see
[CHANGELOG.md](https://github.com/trevismd/statannotations/blob/master/CHANGELOG.md)).

## Installation

From version 0.3.0 on, the package is distributed on PyPi.
The latest stable release (v0.5.0) can be downloaded and installed with:
The latest stable release (v0.6.0) can be downloaded and installed with:
```bash
pip install statannotations
```
Expand All @@ -90,9 +91,9 @@ pip install -r requirements.txt .

## Important note

**! Seaborn ≥ v0.12 is not officially supported, we know there are at least
some bugs. Issues can still be reported (and upvoted) in order to plan further
development to support these versions. Also see
**! Seaborn ≥ v0.12 and pandas 2 are not officially supported, we know there are
at least some bugs. Issues can still be reported (and upvoted) in order to plan
further development to support these versions. Also see
[discussion](https://github.com/trevismd/statannotations/discussions/81)**.

## Usage
Expand Down Expand Up @@ -171,7 +172,7 @@ Bibtex
month = oct,
year = 2022,
publisher = {Zenodo},
version = {v0.5},
version = {v0.6},
doi = {10.5281/zenodo.7213391},
url = {https://doi.org/10.5281/zenodo.7213391}
}
Expand All @@ -181,7 +182,7 @@ Example
Florian Charlier, Marc Weber, Dariusz Izak, Emerson Harkin, Marcin Magnus,
Joseph Lalli, Louison Fresnais, Matt Chan, Nikolay Markov, Oren Amsalem,
Sebastian Proost, Agamemnon Krasoulis, getzze, & Stefan Repplinger. (2022).
Statannotations (v0.5). Zenodo. https://doi.org/10.5281/zenodo.7213391
Statannotations (v0.6). Zenodo. https://doi.org/10.5281/zenodo.7213391
```

## Contributing
Expand Down
Binary file modified docs/build/doctrees/modules.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/setup.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/statannotations.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/statannotations.stats.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e9f3508e439d00c65299ca22c3f70b92
config: 4005375536a5d2c84fa02e5ae18a403d
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions docs/build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ statannotations
:maxdepth: 4

statannotations
custom-test
2 changes: 2 additions & 0 deletions docs/build/html/_sources/statannotations.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ statannotations.Annotation module
:undoc-members:
:show-inheritance:

.. _Annotator_module:

statannotations.Annotator module
--------------------------------

Expand Down
2 changes: 2 additions & 0 deletions docs/build/html/_sources/statannotations.stats.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ statannotations.stats.StatResult module
:undoc-members:
:show-inheritance:

.. _StatTest_module:

statannotations.stats.StatTest module
-------------------------------------

Expand Down
21 changes: 8 additions & 13 deletions docs/build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
min-width: 360px;
max-width: 800px;
}

Expand All @@ -236,7 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
Expand All @@ -247,6 +246,7 @@ span.brackets > a:after {
content: "]";
}


h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -334,13 +334,11 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}

div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -428,10 +426,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -614,7 +608,6 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
float: left;
Expand Down Expand Up @@ -643,11 +636,11 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}


dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand Down Expand Up @@ -731,8 +724,9 @@ dl.glossary dt {

.classifier:before {
font-style: normal;
margin: 0.5em;
margin: 0 0.5em;
content: ":";
display: inline-block;
}

abbr, acronym {
Expand All @@ -756,6 +750,7 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}

div[class*="highlight-"] {
Expand Down Expand Up @@ -819,7 +814,7 @@ div.code-block-caption code {

table.highlighttable td.linenos,
span.linenos,
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
Expand Down
Loading

0 comments on commit 4766703

Please sign in to comment.