compare_runs_CI_plots: Compare two global runs by plotting

View source: R/user_interface.R

compare_runs_CI_plotsR Documentation

Compare two global runs by plotting

Description

Generates “CI” (credible interval) line plots that compare the results of two global model runs. Country- and aggregate-level (if compare_aggregates is TRUE) plots are available.

Usage

compare_runs_CI_plots(
  run_name_1,
  run_name_2,
  run_1_output_folder_path = file.path("output", run_name_1),
  run_1_plot_label = run_name_1,
  run_2_output_folder_path = file.path("output", run_name_2),
  run_2_plot_label = run_name_2,
  output_folder_path = file.path(run_1_output_folder_path, "fig", "compare_runs_plots"),
  plot_data = NULL,
  all_women = NULL,
  compare_aggregates = TRUE,
  verbose = FALSE
)

Arguments

run_1_output_folder_path

Filepath to directory where outputs for run_1_name are saved.

run_1_plot_label

The label to use for “run_1” in the plots. Defaults to run_1_name.

run_2_output_folder_path

See run_1_output_folder_path, but for “run_2”.

run_2_plot_label

See run_2_plot_label, but for “run_2”.

output_folder_path

Filepath to the directory in which the comparison plots will be saved.

plot_data

Logical; should available input data be plotted? Defaults to TRUE unless either all_women is TRUE or “run_1” and “run_2” are from different marital groups.

all_women

Logical; is the run an all women run such as the kind produced by combine_runs or do_global_all_women_run? If NULL an attempt is made to determine this automatically from ‘mcmc.meta.rda’ in the output folder of “run_1”. Note that either both or neither must be either all women runs.

compare_aggregates

Logical; should comparison plots be made for the aggregates as well as the countries? If FALSE only plots for countries are produced.

run_1_name

The name of the first run to compare.

run_2_name

The name of the second run to compare.

Value

Called for the side effect of producing plots.

Author(s)

Mark Wheldon (wrapper) based on underlying function by Jin Rou New and Leontine Alkema.

Jin Rou New, Leontine Alkema, Mark Wheldon

See Also

compare_runs_fishbone_plots.


FPcounts/FPEMglobal documentation built on July 20, 2024, 2:35 a.m.