Skip to main content

matplotlib Based Publication-Ready Plots with Statistical Tests

Project description

ggpubpy

Documentation Status PyPI version Python 3.8+ License: MIT

ggpubpy is a Python library for creating publication-ready plots with built-in statistical tests and automatic p-value annotations. Inspired by R's ggpubr package, ggpubpy provides easy-to-use functions for creating professional visualizations suitable for scientific publications.

Features

  • 📊 Publication-ready plots: Clean, professional appearance suitable for scientific publications
  • 🔬 Built-in statistical tests: Automatic ANOVA, t-tests, correlation analysis, and more
  • Automatic annotations: P-values and significance stars added automatically
  • 🎨 Flexible customization: Extensive options for colors, styling, and layout
  • 📈 Multiple plot types: Box plots, violin plots, correlation matrices, shift plots, and alluvial plots
  • 🔗 Easy integration: Works seamlessly with pandas DataFrames and numpy arrays

Installation

pip install ggpubpy

Quick Start

from ggpubpy import plot_boxplot_with_stats, load_iris
import matplotlib.pyplot as plt

# Load sample data
iris = load_iris()

# Create a publication-ready boxplot with statistical annotations
fig, ax = plot_boxplot_with_stats(
    df=iris,
    x="species",
    y="sepal_length",
    title="Sepal Length by Species"
)

plt.show()

Available Plot Types

📊 Box Plots

Create box plots with statistical annotations including ANOVA/Kruskal-Wallis tests and pairwise comparisons.

from ggpubpy import plot_boxplot_with_stats, load_iris

fig, ax = plot_boxplot_with_stats(
    df=load_iris(),
    x="species",
    y="sepal_length",
    parametric=False  # Use non-parametric tests
)

🎻 Violin Plots

Visualize data distributions with violin plots that combine the benefits of box plots and density plots.

from ggpubpy import plot_violin_with_stats, load_iris

fig, ax = plot_violin_with_stats(
    df=load_iris(),
    x="species",
    y="petal_length",
    palette={"setosa": "#FF6B6B", "versicolor": "#4ECDC4", "virginica": "#45B7D1"}
)

📈 Shift Plots

Perfect for before-after comparisons and paired data analysis.

from ggpubpy import plot_shift
import numpy as np

# Create sample paired data
before = np.random.normal(10, 2, 30)
after = before + np.random.normal(1, 1.5, 30)

fig = plot_shift(
    x=before,
    y=after,
    x_label="Before Treatment",
    y_label="After Treatment"
)

🔗 Correlation Matrix

Comprehensive visualization of relationships between multiple variables.

from ggpubpy import plot_correlation_matrix, load_iris

fig, axes = plot_correlation_matrix(
    df=load_iris(),
    columns=['sepal_length', 'sepal_width', 'petal_length', 'petal_width'],
    title="Iris Dataset Correlation Matrix"
)

🌊 Alluvial Plots

Flow diagrams showing how data moves between categorical dimensions.

from ggpubpy import plot_alluvial, load_titanic
import pandas as pd
import numpy as np

# Load and prepare data
titanic = load_titanic()
titanic = titanic.dropna(subset=["Age"])
titanic["Class"] = titanic["Pclass"].map({1: "1st", 2: "2nd", 3: "3rd"})
titanic["AgeCat"] = np.where(titanic["Age"] < 18, "Child", "Adult")
titanic["Survived"] = titanic["Survived"].astype(str).replace({"0": "No", "1": "Yes"})

# Create frequency table
titanic_tab = (titanic.groupby(["Class", "Sex", "AgeCat", "Survived"])
                    .size()
                    .reset_index(name="Freq")
                    .rename(columns={"AgeCat": "Age"}))
titanic_tab["alluvium"] = titanic_tab.index

# Create alluvial plot
fig, ax = plot_alluvial(
    titanic_tab,
    dims=["Class", "Sex", "Age"],
    value_col="Freq",
    color_by="Survived",
    id_col="alluvium",
    title="Titanic Survival Analysis"
)

Statistical Tests

ggpubpy automatically performs appropriate statistical tests:

  • Global Tests: One-way ANOVA, Kruskal-Wallis
  • Pairwise Comparisons: t-tests, Mann-Whitney U tests
  • Correlation Analysis: Pearson, Spearman, Kendall
  • Significance Levels: *** p < 0.001, ** p < 0.01, * p < 0.05, ns p ≥ 0.05

Documentation

📖 Complete documentation is available at https://ggpubpy.readthedocs.io

The documentation includes:

  • Detailed function references
  • Comprehensive examples
  • Statistical test explanations
  • Customization guides
  • Best practices

Examples

Check out the examples/ directory for complete working examples:

  • basic_usage.py: Introduction to ggpubpy functions
  • alluvial_examples.py: Alluvial plot examples
  • correlation_matrix_example.py: Correlation matrix examples

Dependencies

  • Python 3.8+
  • matplotlib
  • pandas
  • numpy
  • scipy (for statistical tests)

Contributing

We welcome contributions! Please see our contributing guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use ggpubpy in your research, please cite:

@software{ggpubpy,
  title={ggpubpy: Publication-Ready Plots for Python},
  author={Izzet Turkalp Akbasli},
  year={2024},
  url={https://github.com/yourusername/ggpubpy}
}

Support

For questions, bug reports, or feature requests, please open an issue on our GitHub repository.


Happy plotting! 📊✨

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

ggpubpy-0.4.2.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ggpubpy-0.4.2-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file ggpubpy-0.4.2.tar.gz.

File metadata

  • Download URL: ggpubpy-0.4.2.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ggpubpy-0.4.2.tar.gz
Algorithm Hash digest
SHA256 316bd04f4e06942f8c890a85fe8aa0bd9243c253e062c8e8e54ff72e47b10b76
MD5 b813579703fe20d1b82d2ef9883cbb80
BLAKE2b-256 3ed74161c7b4e32fe851c6112407491a8c630d23793ed0e7a7e2eb07acb4ee47

See more details on using hashes here.

File details

Details for the file ggpubpy-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: ggpubpy-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ggpubpy-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8bf11bcb78564bfb56033fca93ab03107bf044182da364559f21ebf18a8844c4
MD5 5a49742747e411b8c17bcf617373e109
BLAKE2b-256 c37af5126a9ff9bca7e0bd443c503cefe6b393c3e3b5c5c151c0e1f0f5e5b562

See more details on using hashes here.

Supported by

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