Skip to contents

Plot a legend for a visual predictive check (VPC)

Source: R/plot_vpc_legend.R
plot_vpc_legend.Rd

Plot a legend for a visual predictive check (VPC)

Usage

plot_vpc_legend(
  ci = 0.9,
  pi = c(0.05, 0.95),
  shown = NULL,
  lloq = NULL,
  theme = NULL,
  type = c("cont", "cens"),
  ...
)

Arguments

ci

Numeric confidence level for simulation intervals (e.g., 0.90 for 90% CI). Should match argument passed to plot_vpc_cont(). Default is 0.90.

pi

prediction intervals plotted. Should match argument passed to plot_vpc_cont(). Default is c(0.05, 0.95). Ignored when type = "cens" (cens VPCs do not have prediction intervals).

shown

Layer visibility settings created by plot_vpc_shown(). Defaults can be viewed by running plot_vpc_shown() with no arguments.

lloq

Numeric scalar or vector of LLOQ values to label in the legend, or NULL to omit. Each unique value becomes one legend entry rendered with the theme's loq_line linetype. Pass compute_out$config$loq from a df_vpcstats() result to mirror the reference lines drawn by plot_build_vpc().

theme

Named list of aesthetic parameters for the plot created by plot_vpc_theme(). Defaults can be viewed by running plot_vpc_theme() with no arguments.

type

One of "cont" (default) or "cens". Selects the labels and layer set the legend describes. Under "cont", the central-tendency entries are labeled "Obs Med", "Sim Med", and "Sim <ci>% CI Med" and the pi entries ("Obs <p1>th and <p2>th", "Sim <p1>th - <p2>th", "Sim <ci>% CI <p1>th and <p2>th") are included when their shown keys are on. Under "cens", the three central-tendency labels are relabeled to "Obs Prop BLQ", "Sim Prop BLQ", "Sim <ci>% CI Prop BLQ" and all pi-related entries are suppressed regardless of shown (cens VPCs have no prediction interval).

...

Other arguments passed to ggplot2::theme().

Value

a ggplot2 object

See also

Other vpc: df_vpcstats(), is_pmx_vpc_plot(), is_vpc_stats(), plot_build_vpc(), plot_vpc_cens(), plot_vpc_cont(), plot_vpc_shown(), plot_vpc_theme()

Examples

plot_vpc_legend()

plot_vpc_legend(
pi = c(0.025, 0.975),
ci = 0.95,
 shown = plot_vpc_shown(obs_point = FALSE, obs_pi_line = TRUE,
 sim_pi_line = FALSE, sim_pi_area = FALSE, sim_pi_ci = TRUE,
 obs_median_line = TRUE,
 sim_median_line = FALSE, sim_median_ci = TRUE))

## Cens VPC legend
plot_vpc_legend(type = "cens", lloq = 1)