forestploter.ForestDataMapping

class forestploter.ForestDataMapping(plot_row='_plot_row', series='_series', ci_column='_ci_column', estimate='estimate', lower='lower', upper='upper', row_type='_row_type', indent='_indent', is_summary='_is_summary')

Map the nine reserved long-table fields to source column names.

Parameters:

plot_rowstr, default “_plot_row”

Visual-row identifier. Records with the same value use exactly the same vertical coordinate.

seriesstr, default “_series”

Series identifier used for style lookup and legend entries.

ci_columnstr, default “_ci_column”

Target CI-column identifier. It must match the key of a forestploter.ForestColumn whose role is "ci".

estimatestr, default “estimate”

Point-estimate field.

lowerstr, default “lower”

Confidence-interval lower-bound field.

upperstr, default “upper”

Confidence-interval upper-bound field.

row_typestr, default “_row_type”

Row-semantic field. Accepted values are "header", "estimate", "summary", and "spacer".

indentstr, default “_indent”

Non-negative indentation-level field.

is_summarystr, default “_is_summary”

Strict boolean field that controls whether the observation uses the summary marker.

Parameters:

• plot_row (str)

• series (str)

• ci_column (str)

• estimate (str)

• lower (str)

• upper (str)

• row_type (str)

• indent (str)

• is_summary (str)

Notes

Prefer the default names. A mapping only renames fields; it does not change the long-table semantics. In particular, it cannot map several wide-form triples to several series. One source record always contains at most one estimate/lower/upper triple.

__init__(plot_row='_plot_row', series='_series', ci_column='_ci_column', estimate='estimate', lower='lower', upper='upper', row_type='_row_type', indent='_indent', is_summary='_is_summary')

Parameters:

• plot_row (str)

• series (str)

• ci_column (str)

• estimate (str)

• lower (str)

• upper (str)

• row_type (str)

• indent (str)

• is_summary (str)

Return type:

None

Methods

__init__([plot_row, series, ci_column, ...])
technical_fields()	Return reserved fields in the recommended physical-file order.

Attributes

ci_column
estimate
indent
is_summary
lower
plot_row
row_type
series
upper