Skip to main content

matplotlib Based Publication-Ready Plots

Project description

PyPI version Downloads Build Status License

ggpubpy: 'matplotlib' Based Publication-Ready Plots

Matplotlib is an excellent and flexible package for elegant data visualization in Python. However, the default plotting routines often require extensive boilerplate and manual styling before figures are ready for publication. Customizing complex plots can be a barrier for researchers and analysts without advanced plotting expertise.

The ggpubpy library provides a suite of easy-to-use functions for creating and customizing Matplotlib-based, publication-ready plots—complete with built-in statistical tests and automatic p-value or significance star annotations. This project is directly inspired by R's ggpubr package.

Find out more at: https://github.com/turkalpmd/ggpubpy


Installation and loading

Install the latest release from PyPI:

pip install ggpubpy

Or install the development version directly from GitHub:

pip install git+https://github.com/turkalpmd/ggpubpy.git

Load the package:

import ggpubpy
from ggpubpy import violinggplot, boxggplot
from ggpubpy.datasets import load_iris  # Built-in datasets

Core Features

  • Violin + boxplot + jitter in one call
  • Automatic color palettes with ColorBrewer-inspired defaults
  • Built-in datasets (iris) for quick testing and examples
  • Flexible group comparisons - works with 2-group, 3-group, or more
  • Built-in Kruskal–Wallis & Mann–Whitney U tests (or ANOVA & t-tests for parametric option)
  • Automatic p-value or "star" annotation with dynamic bracket placement
  • Smart p-value formatting - pairwise comparisons show significance stars (*, **, ns), global tests show formatted values (<0.001)
  • Parametric and non-parametric statistical tests with parametric=True/False option
  • Smart test selection - t-test for 2 groups, ANOVA for 3+ groups (parametric mode)
  • Modular, data-driven API: custom labels, ordering, figure sizing

Quick Examples

🎻 Violin plots with boxplots & jitter + statistical tests

3-Group Comparison (All Species)

import ggpubpy
from ggpubpy.datasets import load_iris

# Load the iris dataset
iris = load_iris()

# Create the plot with default colors (automatic palette)
fig, ax = ggpubpy.violinggplot(
    df=iris, 
    x="species", 
    y="sepal_length",
    x_label="Species", 
    y_label="Sepal Length (cm)"
)

Violin Plot Example

2-Group Comparison (Subset Analysis)

# Filter for 2-group comparison
iris_2groups = iris[iris['species'].isin(['setosa', 'versicolor'])]

# Create 2-group comparison plot
fig, ax = ggpubpy.violinggplot(
    df=iris_2groups, 
    x="species", 
    y="sepal_length",
    x_label="Species", 
    y_label="Sepal Length (cm)"
)

Violin Plot 2-Groups

📊 Boxplots with jitter + statistical tests

3-Group Box Plot with Default Colors

# Create boxplot with default automatic colors
fig, ax = ggpubpy.boxggplot(
    df=iris, 
    x="species", 
    y="sepal_length",
    x_label="Species", 
    y_label="Sepal Length (cm)"
)

Box Plot Example

2-Group Box Plot with Statistical Tests

# 2-group comparison with Mann-Whitney U test (non-parametric default)
iris_2groups = iris[iris['species'].isin(['setosa', 'versicolor'])]

fig, ax = ggpubpy.boxggplot(
    df=iris_2groups, 
    x="species", 
    y="sepal_length",
    x_label="Species", 
    y_label="Sepal Length (cm)",
    parametric=False  # Non-parametric tests (default)
)

Box Plot 2-Groups

🎨 Advanced Features

# Custom color palette
custom_palette = {
    "setosa": "#FF6B6B", 
    "versicolor": "#4ECDC4", 
    "virginica": "#45B7D1"
}

fig, ax = ggpubpy.violinggplot(
    df=iris, 
    x="species", 
    y="petal_length",
    x_label="Species", 
    y_label="Petal Length (cm)",
    palette=custom_palette
)

# Parametric tests (ANOVA + t-test instead of Kruskal-Wallis + Mann-Whitney)
fig, ax = ggpubpy.violinggplot(
    df=iris, 
    x="species", 
    y="sepal_length",
    x_label="Species", 
    y_label="Sepal Length (cm)",
    parametric=True
)

# Custom ordering
fig, ax = ggpubpy.violinggplot(
    df=iris, 
    x="species",
    y="petal_width",
    order=["virginica", "versicolor", "setosa"]  # Custom order
)

📊 Built-in Datasets

# Load built-in datasets
iris = ggpubpy.datasets.load_iris()
print(f"Available datasets: {ggpubpy.datasets.list_datasets()}")

# Get recommended color palette for iris species
palette = ggpubpy.datasets.get_iris_palette()
print(palette)  # {'setosa': '#00AFBB', 'versicolor': '#E7B800', 'virginica': '#FC4E07'}

🤝 Contributing

We welcome contributions! This project is designed to be contribution-friendly.

Ways to Contribute:

  • 🐛 Bug reports and feature requests
  • 📖 Documentation improvements
  • 🔧 Code contributions (new features, optimizations, tests)
  • 🎨 New plot types and statistical tests
  • 📊 Additional datasets and examples

Getting Started:

# Clone and setup development environment
git clone https://github.com/turkalpmd/ggpubpy.git
cd ggpubpy
pip install -e .
pip install -r requirements-dev.txt

# Run tests to verify setup
python final_check.py

See CONTRIBUTING.md for detailed guidelines.


📚 Documentation & Support

  • Full Documentation: Read the Docs (Sphinx-generated)
  • API Reference: Complete function documentation with examples
  • GitHub Issues: Bug reports and feature requests
  • GitHub Discussions: Questions and community discussion

License

ggpubpy is released under the MIT License. See LICENSE for 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

ggpubpy-0.1.0.tar.gz (25.9 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.1.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggpubpy-0.1.0.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for ggpubpy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aa6ab02c84f7a347635741cf1dbb3803ac8da8373661907e0d1991d7f7fc6ba3
MD5 316072ec650f99850e50f2c51dee918a
BLAKE2b-256 91ad67fe2b41f12e02b09d02fdb46d61d1f4512a0994bb1b752d425999e07ffb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggpubpy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for ggpubpy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ec2f9630f1b3590ff708b54f3a52c59eddd6aefddbfe75334e4f9e9b91beac3
MD5 0a6615a4b5278057b9ab2af55ed6a6ae
BLAKE2b-256 bae3773db4db52320aaf094d74bf447b837407f1201b90f33c082850501120e0

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