forestploter documentation
Auditable forest plots from XLSX/CSV long tables
forestploter places table text, statistical estimates, and confidence
intervals in one shared row-and-column geometry. XLSX preserves values, record
order, and supported vertical merges; CSV uses the same logical fields. You
calculate the statistics, while the package reads, validates, lays out, and
renders the figure.
Current capabilities
recommended XLSX input and compatible UTF-8 CSV input;
single or multiple series and one or more CI columns;
explicit cross-column alignment through
_plot_row;ordinary estimates, summary diamonds, clipping arrows, guide lines, and legends;
three-rule tables by default with optional side borders, internal row separators, and vertical column separators;
independently editable per-series CI text aligned with each plotted row;
vertically merged display cells with centered text and suppressed internal rules;
header wrapping, automatic header height and width growth, hierarchical indentation, themes, and layout diagnostics;
PNG, SVG, and other Matplotlib-supported static exports.
Start with Getting started, use Data contract when preparing non-trivial workbooks, browse the Example gallery, and consult API reference for complete signatures and parameter definitions.
Note
Version 0.1.0rc1 is a quality-first public preview. All CI columns currently share one global linear coordinate configuration.
User guide
- Getting started
- Data contract
- Two independent column orders
- Field dictionary
- Row-type recipes
- Complete single-CI example
- Multiple series: header row and indented children
- Multiple CI columns: duplicate records, share a visual row
- Multiple series, multiple CI columns, and trailing text
- XLSX merge rules
- CSV compatibility
- Accepted versus recommended input
- Clipping semantics
- Example gallery