pyforce-plot 0.1.1

Python implementation of ggforce-style annotations for matplotlib

PyForce

Python implementation of ggforce-style annotations for matplotlib.

PyForce brings the elegant annotation capabilities of R's ggforce package to Python's matplotlib. Create publication-quality visualizations with smart annotations.

Features

• Smart Point Annotations (annotate_points) - Elbow connectors with adjustText for collision avoidance
• Margin Annotations (annotate_margin) - 3-segment connectors with labels at plot edges
• Edge Annotations (annotate_edge) - Universal function for heatmaps, line plots, any plot
• Convex Hull Groupings (geom_mark_hull) - Smooth boundaries around point groups

Installation

pip install pyforce-plot

Or install from source:

git clone https://github.com/albert-ying/pyforce
cd pyforce
pip install -e .

Examples

Smart Elbow Annotations

from pyforce import annotate_points

annotate_points(
    ax, x, y,
    labels=gene_names,
    indices=sig_indices,
    point_size=60,
    connector_type="elbow",
    force_points=1.5,
)

Margin Annotations (3-segment connectors)

from pyforce import annotate_margin

annotate_margin(
    ax, x, y,
    labels=gene_names,
    indices=sig_indices,
    side="both",  # 'right', 'left', or 'both'
)

Edge Annotations (Universal)

Works for heatmaps, line plots, or any plot:

from pyforce import annotate_edge

# For heatmap rows
annotate_edge(
    ax,
    y_positions=[74, 75, 76],
    labels=["Target_A", "Target_B", "Target_C"],
    x_start=n_cols - 0.5,  # Heatmap edge
    min_spacing=2.0,
)

# For line plot ends
annotate_edge(
    ax,
    y_positions=[y1[-1], y2[-1], y3[-1]],
    labels=["Line 1", "Line 2", "Line 3"],
    x_start=x[-1],  # End of lines
    min_spacing=0.4,
)

Smart dodge: Straight line when labels are far apart, 3-segment (1/3 + 1/3 + 1/3) when close.

Hull Annotations

from pyforce import geom_mark_hull

geom_mark_hull(
    ax, x, y,
    groups=groups,
    labels=["Cluster A", "Cluster B", "Cluster C"],
    hull_alpha=0.12,
)

API Reference

annotate_points()

Smart elbow annotations with adjustText collision avoidance.

Parameter	Type	Default	Description
ax	Axes	required	Matplotlib axes
x, y	array-like	required	Point coordinates
labels	list[str]	required	Labels for points
indices	array-like	None	Indices to annotate
connector_type	str	'elbow'	'elbow', 'straight', 'horizontal'
force_points	float	1.0	Repulsion from points

annotate_margin()

Labels aligned at plot margins with 3-segment connectors.

Parameter	Type	Default	Description
ax	Axes	required	Matplotlib axes
x, y	array-like	required	Point coordinates
labels	list[str]	required	Labels for points
side	str	'right'	'right', 'left', 'both'

annotate_edge()

Universal edge annotation for any plot type.

Parameter	Type	Default	Description
ax	Axes	required	Matplotlib axes
y_positions	list[float]	required	Y positions to annotate
labels	list[str]	required	Labels
x_start	float	None	X where connectors start
side	str	'right'	'right' or 'left'
min_spacing	float	auto	Min spacing between labels

geom_mark_hull()

Convex hull annotations for grouped data.

Parameter	Type	Default	Description
ax	Axes	required	Matplotlib axes
x, y	array-like	required	Point coordinates
groups	array-like	None	Group membership
labels	list[str]	None	Group labels
hull_alpha	float	0.2	Fill transparency

Requirements

• Python >= 3.8
• numpy >= 1.20.0
• matplotlib >= 3.5.0
• scipy >= 1.7.0
• adjustText >= 0.8

License

MIT License

Acknowledgments

Inspired by ggforce for R.