Skip to contents

Generate a Comprehensive Model Analysis Report

plot_report.Rd

Creates a multi-panel visualization report that combines key analytical plots into a single comprehensive display. The report can include:

  • Model fit visualization with confidence intervals

  • Breakpoint posterior distributions (if breakpoints were inferred)

  • Growth rate posterior distributions

  • Model selection diagnostics (if multiple models were compared)

Each component is automatically included based on the available data and analysis in the bipod object, creating a tailored summary of the modeling results.

Usage

plot_report(
  x,
  fit_type = "complex",
  breakpoints_color = "darkgray",
  shadows_colors = NULL,
  t0_posterior_color = "darkorange",
  full_process = FALSE
)

Arguments

x

A bipod object that must contain: * 'fit' field with model fitting results * metadata fields with model selection information * Optional: breakpoints analysis results * Optional: ELBO values for variational inference

fit_type

Character string controlling fit plot complexity: * "simple": Basic fit visualization * "complex": Detailed fit visualization with additional elements Default is "complex"

breakpoints_color

Character string specifying color for breakpoint posterior visualization. Default is "darkgray"

shadows_colors

Character vector defining colors for time window highlighting in fit plot. Default is NULL

t0_posterior_color

Character string specifying color for t0 (initial time) posterior visualization. Default is "darkorange"

full_process

Logical indicating whether to show complete process details in simple fit plots. Only applies when fit_type = "simple". Default is FALSE

Value

A patchwork object containing:

  • Main panel: Model fit visualization

  • Secondary panels (if applicable):

    • Breakpoint posterior distributions

    • Growth rate posterior distributions

    • Model selection results All panels are arranged vertically with appropriate size ratios

Details

The function automatically adapts its output based on the analyses present in the input bipod object:

  • Breakpoint analysis panels only appear if breakpoints were inferred

  • Model selection panels only appear if multiple models were compared

  • Panel heights are automatically adjusted for optimal visualization