VPC layer visibility settings

Constructor for the shown argument of the VPC plot functions and plot_vpc_legend(), controlling which VPC layers are built. Call with no arguments to view the defaults; pass TRUE/FALSE overrides to customize. Each element maps 1:1 with a style_vpc() role/series key.

Usage

plot_vpc_shown(
  obs_point = NULL,
  obs_pi_line = NULL,
  obs_median_line = NULL,
  sim_pi_line = NULL,
  sim_pi_ci = NULL,
  sim_pi_area = NULL,
  sim_median_line = NULL,
  sim_median_ci = NULL,
  loq_line = NULL
)

Arguments

obs_point

Show observed data points. Default is TRUE.

obs_pi_line

Show observed quantile lines. Default is TRUE.

obs_median_line

Show observed median line. Default is TRUE.

sim_pi_line

Show simulated prediction interval lines. Default is FALSE.

sim_pi_ci

Show simulated prediction interval CI ribbons. Default is TRUE.

sim_pi_area

Show simulated prediction interval as shaded area. Default is FALSE.

sim_median_line

Show simulated median line. Default is FALSE.

sim_median_ci

Show simulated median CI ribbon. Default is TRUE.

loq_line

Show the LLOQ reference line on standard VPCs, and its entry in plot_vpc_legend(). Default is TRUE.

Value

A vpc_shown object: a named list of TRUE/FALSE.

See also

Other vpc: df_vpcstats(), is_pmx_vpc_plot(), is_vpc_stats(), plot_build_vpc(), plot_vpc_cens(), plot_vpc_cont(), plot_vpc_legend(), style_vpc()

Examples

plot_vpc_shown()
#> <vpc_shown>
#>   obs_point        TRUE
#>   obs_pi_line      TRUE
#>   obs_median_line  TRUE
#>   sim_pi_line      FALSE
#>   sim_pi_ci        TRUE
#>   sim_pi_area      FALSE
#>   sim_median_line  FALSE
#>   sim_median_ci    TRUE
#>   loq_line         TRUE
plot_vpc_shown(obs_point = FALSE, sim_pi_line = TRUE)
#> <vpc_shown>
#>   obs_point        FALSE
#>   obs_pi_line      TRUE
#>   obs_median_line  TRUE
#>   sim_pi_line      TRUE
#>   sim_pi_ci        TRUE
#>   sim_pi_area      FALSE
#>   sim_median_line  FALSE
#>   sim_median_ci    TRUE
#>   loq_line         TRUE