build_forest_overview: Build an overview forest plot paired with the heatmap

View source: R/plot_forests.R

build_forest_overviewR Documentation

Build an overview forest plot paired with the heatmap

Description

Compact forest showing Female, Male, Both meta PR for every concept. Concept y-axis ordering matches the heatmap.

Usage

build_forest_overview(
  meta_sex_df,
  meta_summary_df,
  concept_ids,
  concept_info,
  name1,
  name2,
  scale_mode = "log2",
  concept_order = NULL
)

Arguments

meta_sex_df

Meta-analysis by sex data (F/M rows).

meta_summary_df

Meta-analysis summary data (Both rows).

concept_ids

Vector of concept_ids to include.

concept_info

Data frame with concept_id, concept_name, concept_code, pop_weight.

name1

Reference dataset name.

name2

Comparison dataset name.

scale_mode

"fold" or "log2".

concept_order

Vector of concept_ids in desired display order.

Value

A girafe object.


syrona documentation built on Sept. 5, 2026, 1:06 a.m.