demog_plot_SO: Make a set of plots showing the demographics used in a set of...

In shirewoman2/Consultancy: Standardized tools for using R within the Simcyp Consultancy Team

Make a set of plots showing the demographics used in a set of simulations and optionally compare them to observed demographics. UNDER CONSTRUCTION.

Description

Make a set of plots showing the demographics used in a set of simulations and optionally compare them to observed demographics. UNDER CONSTRUCTION.

Usage

demog_plot_SO(
  demog_dataframe,
  sim_data_file = NA,
  graph_title = "Demographics",
  variables = NA,
  obs_alpha = 0.8,
  sim_alpha = 0.4,
  ncol = NULL,
  nrow = NULL,
  facet_by_sex = FALSE,
  border_facets = TRUE,
  graph_labels = TRUE
)

Arguments

demog_dataframe	the output from running extractDemog. Optionally (and we recommend) with added observed demographic data, perhaps from observed overlay XML files.
sim_data_file	the simulator output Excel file to use. If left as NA, all the files in demog_dataframe will be included.
graph_title	title to use on the plots
variables	variables to include. We're starting with a limited set: "Age", "Weight_kg" ("Weight" is also fine), "Height_cm" ("Height" is fine), "Weight vs Height", "Height vs Age", "Weight vs Age", "HSA_gL" ("HSA" is fine), "AGP_gL" ("AGP" is fine), "Sex", "Sex vs Age", "BMI_kgm2" ("BMI" is fine), and "RenalFunction". If you want only a subset of those, list them in a character vector, e.g., variables = c("Age", "Height_cm", "Weight_kg"). Plots will be in the order listed.
obs_alpha	how transparent to make the observed data, with 0 being completely transparent and invisible so I don't know why you'd want that but, hey, you do you, dude, to 1, which is fully opaque.
sim_alpha	how transparent to make the simulated data. See notes on the obs_alpha argument.
ncol	optionally specify the number of columns. If left as NULL, a reasonable guess will be used.
nrow	optionally specify the number of rows. If left as NULL, a reasonable guess will be used.
facet_by_sex	TRUE or FALSE (default) for whether to break up the graphs into facets based on the sex of the subjects
border_facets	TRUE (default) or FALSE for whether to include a border around the facets if the graphs are broken up by the sex of the subjects
graph_labels	TRUE or FALSE for whether to include labels (A, B, C, etc.) for each of the small graphs.

Value

a set of graphs. This does not yet save the graphs for you, so you'll need to run ggsave(...) to do that.

Examples

# none yet

shirewoman2/Consultancy documentation built on Feb. 18, 2025, 10 p.m.