MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface ForestPlotConfig

    Configuration for forest plots. Optional when chartType is 'forest', but a forest plot that declares no nullValue gets no claim about significance — see nullValue.

    interface ForestPlotConfig {
        weightKey?: string;
        pooledKey?: string;
        pooledIndex?: number;
        nullValue?: number;
    }
    Index

    Properties

    weightKey?: string

    Key holding the study's weight in the pooled estimate, as a fraction of one. A forest plot encodes this as marker area, which no reader is otherwise told: two studies whose intervals look alike can contribute wholly differently to the result.

    pooledKey?: string

    Key whose truthy value marks a row as the pooled summary rather than a study.

    pooledIndex?: number

    Index of the pooled summary row, for data that carries no flag column. A meta-analysis draws the pooled row last, so this is usually data.length - 1.

    nullValue?: number

    The value that means "no effect" — 1 for a ratio measure, 0 for a difference. It is the <ReferenceLine> the chart draws, and whether a study's interval crosses it is that study's result.

    There is deliberately no default: guessing 0 for a ratio chart reports every study as not crossing, since odds ratios are all positive.