Skip to contents

Constructor and factory for controlling which VPC layers are displayed. Call with no arguments to view defaults. Pass overrides to customize. Each element maps 1:1 with a plot_vpc_theme() aesthetic 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
)

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.

Value

A named list of logicals

Examples

plot_vpc_shown()
#> $obs_point
#> [1] TRUE
#> 
#> $obs_pi_line
#> [1] TRUE
#> 
#> $obs_median_line
#> [1] TRUE
#> 
#> $sim_pi_line
#> [1] FALSE
#> 
#> $sim_pi_ci
#> [1] TRUE
#> 
#> $sim_pi_area
#> [1] FALSE
#> 
#> $sim_median_line
#> [1] FALSE
#> 
#> $sim_median_ci
#> [1] TRUE
#> 
plot_vpc_shown(obs_point = FALSE, sim_pi_line = TRUE)
#> $obs_point
#> [1] FALSE
#> 
#> $obs_pi_line
#> [1] TRUE
#> 
#> $obs_median_line
#> [1] TRUE
#> 
#> $sim_pi_line
#> [1] TRUE
#> 
#> $sim_pi_ci
#> [1] TRUE
#> 
#> $sim_pi_area
#> [1] FALSE
#> 
#> $sim_median_line
#> [1] FALSE
#> 
#> $sim_median_ci
#> [1] TRUE
#>