MAIDR Documentation - v4.4.0
    Preparing search index...
    • Binds a D3.js forest plot to MAIDR, generating the accessible data representation.

      A forest plot is a point-range chart of studies against a shared null line, so selector matches one element per study exactly as bindD3ErrorBar's does, and the bounds are the same absolute positions on the value axis.

      Three things make it a forest plot rather than an error bar, and each is what a sighted reader takes from the drawing:

      • nullValue — the line at 1 (a ratio) or 0 (a difference). Whether a study's interval crosses it is the result for that study, and the trace announces the crossing. Without it, no claim about significance is made: there is no default, because a ratio chart guessed at 0 would report every study as not crossing.
      • weight — the marker area, which is a magnitude a reader is otherwise never told; two studies whose intervals look alike can contribute wholly differently to the result.
      • pooledSelector — the diamond at the bottom. It is drawn as a different mark from the studies, so it is selected separately and appended after them; it is not evidence, it is what the evidence came to, and announcing it as one more study invites a reader to count it among them.

      Parameters

      • svg: Element

        The SVG element containing the D3 forest plot.

      • config: D3ForestConfig

        Configuration specifying the selectors and data accessors.

      Returns D3BinderResult

      A D3BinderResult with the MAIDR data and generated layer.

      bindD3Forest(svgElement, {
      selector: 'g.study',
      pooledSelector: 'path.pooled',
      title: 'Effect of the Intervention',
      orientation: Orientation.HORIZONTAL,
      axes: { x: 'Odds ratio', y: 'Study' },
      x: 'study',
      y: 'or',
      yMin: 'ciLow',
      yMax: 'ciHigh',
      weight: 'weight',
      nullValue: 1,
      });