Skip to content

Commit fdafa74

Browse files
spec: add forest-basic specification (#2381)
## New Specification: `forest-basic` Related to #2378 --- ### specification.md # forest-basic: Meta-Analysis Forest Plot ## Description A forest plot displays effect sizes with confidence intervals from multiple studies in a meta-analysis. Each study is represented as a point estimate with horizontal whiskers showing the confidence interval, and a diamond at the bottom shows the pooled estimate. The plot includes a vertical reference line at the null effect (typically 0 or 1), making it easy to assess statistical significance and heterogeneity across studies. ## Applications - Summarizing results from systematic reviews in medical research - Comparing treatment effects across multiple clinical trials - Visualizing heterogeneity and consistency of findings across studies - Presenting pooled effect estimates with confidence intervals ## Data - `study` (str) - Study name or identifier - `effect_size` (float) - Point estimate of the effect (e.g., odds ratio, risk ratio, mean difference) - `ci_lower` (float) - Lower bound of the confidence interval - `ci_upper` (float) - Upper bound of the confidence interval - `weight` (float, optional) - Study weight for visual sizing of markers - Size: 5-30 studies - Example: Meta-analysis of randomized controlled trials comparing treatment vs control ## Notes - Diamond shape for the pooled/overall estimate at the bottom - Vertical reference line at null effect (0 for mean difference, 1 for ratios) - Marker size proportional to study weight when provided - Studies typically ordered by effect size or chronologically - Clear axis labels showing the effect measure and scale --- **Next:** Add `approved` label to the issue to merge this PR. --- :robot: *[spec-create workflow](https://github.com/MarkusNeusinger/pyplots/actions/runs/20543221935)* Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 723ba9a commit fdafa74

2 files changed

Lines changed: 60 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# forest-basic: Meta-Analysis Forest Plot
2+
3+
## Description
4+
5+
A forest plot displays effect sizes with confidence intervals from multiple studies in a meta-analysis. Each study is represented as a point estimate with horizontal whiskers showing the confidence interval, and a diamond at the bottom shows the pooled estimate. The plot includes a vertical reference line at the null effect (typically 0 or 1), making it easy to assess statistical significance and heterogeneity across studies.
6+
7+
## Applications
8+
9+
- Summarizing results from systematic reviews in medical research
10+
- Comparing treatment effects across multiple clinical trials
11+
- Visualizing heterogeneity and consistency of findings across studies
12+
- Presenting pooled effect estimates with confidence intervals
13+
14+
## Data
15+
16+
- `study` (str) - Study name or identifier
17+
- `effect_size` (float) - Point estimate of the effect (e.g., odds ratio, risk ratio, mean difference)
18+
- `ci_lower` (float) - Lower bound of the confidence interval
19+
- `ci_upper` (float) - Upper bound of the confidence interval
20+
- `weight` (float, optional) - Study weight for visual sizing of markers
21+
- Size: 5-30 studies
22+
- Example: Meta-analysis of randomized controlled trials comparing treatment vs control
23+
24+
## Notes
25+
26+
- Diamond shape for the pooled/overall estimate at the bottom
27+
- Vertical reference line at null effect (0 for mean difference, 1 for ratios)
28+
- Marker size proportional to study weight when provided
29+
- Studies typically ordered by effect size or chronologically
30+
- Clear axis labels showing the effect measure and scale
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Specification-level metadata for forest-basic
2+
# Auto-synced to PostgreSQL on push to main
3+
4+
spec_id: forest-basic
5+
title: Meta-Analysis Forest Plot
6+
7+
# Specification tracking
8+
created: 2025-12-27T19:13:20Z
9+
updated: 2025-12-27T19:13:20Z
10+
issue: 2378
11+
suggested: MarkusNeusinger
12+
13+
# Classification tags (applies to all library implementations)
14+
# See docs/concepts/tagging-system.md for detailed guidelines
15+
tags:
16+
plot_type:
17+
- forest
18+
- errorbar
19+
data_type:
20+
- numeric
21+
- categorical
22+
domain:
23+
- healthcare
24+
- research
25+
- statistics
26+
features:
27+
- basic
28+
- confidence-interval
29+
- comparison
30+
- meta-analysis

0 commit comments

Comments
 (0)