Skip to main content

Visualize statistical significance on existing Matplotlib plots by adding

Project description

✨ starbars ✨

This Python tool helps visualizing statistical significance on existing Matplotlib plots by adding significance bars and p-value labels between chosen pairs of columns.

Example plot

Features

  • Converts p-values to asterisk notations for easy interpretation.
  • Draws statistical significance bars on Matplotlib plots.
  • Customizable bar margins, tip lengths, font sizes, and top margins.

Installation

You can install the package via pip:

pip install starbars

Example

import starbars
import matplotlib.pyplot as plt

# Example data
categories = ['A', 'B', 'C']
values = [10, 20, 15]
annotations = [('A', 'B', 0.01), ('B', 'C', 0.05)]
plt.bar(categories, values)

# Annotate significance
starbars.draw_annotation(annotations)

plt.show()

This example creates a simple bar plot and uses the draw_annotation function to add statistical significance annotations between the specified pairs. For more detailed examples, please check the example.

Parameters

  • annotations: List of tuples (x1, x2, p) containing the x-axis labels and the p-value of the pair.
  • ns_show: Whether to show bars for non-statistical p-values. (Default: True)
  • ax: The axis of subplots to draw annotations on. If ax is not provided, it implies that you are working with a single plot rather than a set of subplots. In such cases, the annotations apply to the only existing plot in the figure. (Default: None)
  • bar_margin: Margin of the bar from data. Default is 3% of the data.
  • tip_length: Length of the tip of the statistical bar. Default is 3% relative to data range.
  • fontsize: Font size of the annotations.
  • top_margin: Margin of the last annotation from the top of the graph. Default is 3% of the data.

Contributing

We welcome contributions! If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -m 'Add some amazing feature').
  4. Push to the branch (git push origin feature-branch)
  5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starbars-1.3.2.tar.gz (186.5 kB view details)

Uploaded Source

Built Distribution

starbars-1.3.2-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file starbars-1.3.2.tar.gz.

File metadata

  • Download URL: starbars-1.3.2.tar.gz
  • Upload date:
  • Size: 186.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for starbars-1.3.2.tar.gz
Algorithm Hash digest
SHA256 c4037b0d6778c099250d04a8626349bcd83172553ab052bf2acd381e5a9a5c7a
MD5 5a323258b0aabe774d95fff560b61095
BLAKE2b-256 4c506932a5067b9c6c0efe3086427907f413ba85b283444d1814c26389982a6d

See more details on using hashes here.

File details

Details for the file starbars-1.3.2-py2.py3-none-any.whl.

File metadata

  • Download URL: starbars-1.3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for starbars-1.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 58397a3c3d3120fba480276f82cd11000bbc9673f90dc9c77d47548c101b27b0
MD5 8ce2d4406f0d23efcf98cba59ff6a483
BLAKE2b-256 321cd15eccd09f158057cf6be6fe7e31bd13cff4c2508f0c28ec1c455e23b3aa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page