plot_std_VPC: Plot VPC using output of calc_std_VPC function.

Description Usage Arguments Value Note Author(s)

View source: R/plot_std_VPC.R

Description

Function for production of standard VPC plots.

Usage

1
2
3
4
5
plot_std_VPC(VPC_results, x_lab = "Time after dose (hours)",
  y_lab = "Prediction-corrected concentration (ug/L)",
  add_simulated_median = TRUE, prediction_corrected = TRUE,
  plot_obs = FALSE, plot_outer = TRUE, legend_position = "topright",
  bw = FALSE, legend_size = 0.7, col_scheme = FALSE, ...)

Arguments

VPC_results

list. Output of calc_std_VPC function.

x_lab

label for the x axis.

y_lab

label for the y axis.

add_simulated_median

TRUE (default) or FALSE. Add simulated median quantile to bins in plot.

prediction_corrected

TRUE (default) or FALSE. Produce a prediction-corrected VPC plot.

plot_obs

TRUE (default) or FALSE. Overlay observed data points on plot.

plot_outer

TRUE (default) or FALSE. If FALSE then the outer percentiles (typically 10 and 90) are omitted from the VPC. Important with small experimental datasets.

legend_position

FALSE or "bottomright"/"bottom"/"bottomleft"/"left"/"topleft"/"top"/"topright"/"right"/"center". Descriptive position of legend in plot. FALSE ensures no legend is produced.

bw

TRUE or FALSE (default). If set to TRUE a black and white output is given, which is required for certain submission reports.

legend_size

positive numeric. Typically in range 0.4 to 3 (from cex argument in legend).

col_scheme

defaults to FALSE. Can be used for setting a user-defined colouring of VPC plot elements using the format of:

col_scheme = c('gray90', 'black', 'orange', 'red'),

where:

1st colour is for shading of outer confidence intervals of simulated data.

2nd colour is for 50th percentiles of simulated data in outer percentiles and median.

3rd colour is for outer experimental percentiles.

4th colour is for 50th experimental percentile.

Value

A standard VPC plot. By default, lines showing 10th percentile, 50th percentile and 90th percentile of experimental and simulated data are shown. 95% confidence intervals around the simulated 10, 50, 90 percentiles are shown as shaded boxes.

Note

The user can add standard R plot() arguments such as log='y', xlim=c(0,100), yaxt='n', main='VPC' etc. to customize the VPC plot.

Author(s)

Rupert Austin


jgrevel/BAST1-R-Library documentation built on May 21, 2019, 10:11 a.m.