plot_vpc_helper: Helper function to simplify vpc plotting (not intended to be...

In ronkeizer/vpc: Create Visual Predictive Checks

Helper function to simplify vpc plotting (not intended to be called directly)

Description

Helper function to simplify vpc plotting (not intended to be called directly)

Usage

plot_vpc_helper(
  db,
  show = NULL,
  vpc_theme = NULL,
  smooth = TRUE,
  log_x = FALSE,
  log_y = FALSE,
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  verbose = FALSE
)

## Default S3 method:
plot_vpc_helper(db, ...)

## S3 method for class 'vpcdb_continuous'
plot_vpc_helper(
  db,
  ...,
  show = NULL,
  vpc_theme = NULL,
  smooth = TRUE,
  log_x = FALSE,
  log_y = FALSE,
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  verbose = FALSE
)

## S3 method for class 'vpcdb_categorical'
plot_vpc_helper(db, ...)

## S3 method for class 'vpcdb_censored'
plot_vpc_helper(db, ...)

## S3 method for class 'vpcdb_time_to_event'
plot_vpc_helper(
  db,
  ...,
  show = NULL,
  vpc_theme = NULL,
  smooth = TRUE,
  log_x = FALSE,
  log_y = FALSE,
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  verbose = FALSE
)

Arguments

db	object created using the 'vpc' function
show	what to show in VPC (obs_dv, obs_ci, pi, pi_as_area, pi_ci, obs_median, sim_median, sim_median_ci)
vpc_theme	theme to be used in VPC. Expects list of class vpc_theme created with function vpc_theme()
smooth	"smooth" the VPC (connect bin midpoints) or show bins as rectangular boxes. Default is TRUE.
log_x	Boolean indicting whether x-axis should be shown as logarithmic. Default is FALSE.
log_y	Boolean indicting whether y-axis should be shown as logarithmic. Default is FALSE.
xlab	label for x axis
ylab	label for y axis
title	title
verbose	show debugging information (TRUE or FALSE)

ronkeizer/vpc documentation built on May 11, 2023, 11:09 p.m.