Skip to contents

Plot estimated model quantities

Source: R/plot_estimates.R
plot_estimates.Rd

Generate a ggplot2 object plotting estimated quantities over time, optionally compared to the simulated values.

Usage

plot_estimates(
  hiv_list,
  quantity,
  start_year = 0,
  chain_results = FALSE,
  hiv_list_2 = NULL,
  model_1_name = "Model 1",
  model_2_name = "Model 2",
  credible_intervals = TRUE,
  sim_comparison = c("sampled", "generative"),
  colours = NULL
)

Arguments

hiv_list

A list returned from the postproc function containing model estimates, or a named list of model results. Names are used as plot labels.

quantity

A string specifying the quantity to plot. Options are "incidence", "undiag_prev", "undiag_migration", "all_migration", "diag_prob", "diagnoses", "migration_prob", "transfers", "transfers_detected", "ratio_abroad_uk", "detect_prob", and "migrant_hiv_prevalence".

start_year

An integer specifying the starting year for the x-axis (default is 0).

chain_results

A logical indicating whether to plot chain-by-chain estimates (default is FALSE).

hiv_list_2

An optional second list of model estimates for comparison (default is NULL).

model_1_name

A string specifying the name of the first model for the legend (default is "Model 1").

model_2_name

A string specifying the name of the second model for the legend (default is "Model 2").

credible_intervals

A logical indicating whether to plot 95% credible intervals (default is TRUE).

sim_comparison

A string specifying which simulated values to compare against when hiv_list contains simulated data. Options are "sampled" (the stochastic realisation for the particular seed, the default) or "generative" (deterministic expected values).

colours

Optional character vector of model or chain colours. Unnamed values are matched in legend order; named values must match legend labels.

Value

A ggplot2 object.

Examples

# See ?run_backcalc for a full end-to-end workflow.
invisible(NULL)