Sensitivity spider plot for PK parameters

Sensitivity spider plot for PK parameters

Usage

sensitivitySpiderPlot(
  sensitivityCalculation,
  outputPaths = NULL,
  parameterPaths = NULL,
  pkParameters = NULL,
  xAxisLog = TRUE,
  yAxisLog = FALSE,
  savePlots = FALSE,
  outputFolder = "",
  width = 16,
  height = 9,
  dpi = 300
)

Arguments

sensitivityCalculation

The SensitivityCalculation object returned by sensitivityCalculation().

outputPaths, parameterPaths, pkParameters

A single or a vector of the output path(s), parameter path(s), and PK parameters to be displayed, respectively. If NULL, all included paths and parameters present in the supplied SensitivityCalculation object will be displayed in the visualization.

xAxisLog, yAxisLog

Logical that decides whether to display the axis on logarithmic scale.

savePlots

Logical that decides whether you wish to save created plot(s). They are not saved by default. Note that if there are multiple output paths in your model, there will be multiple plots that will be saved.

outputFolder

A character string describing path folder where plots need to be saved. The path must be relative to the current working directory. By default (""), the plots will be saved in the current working directory (which can be found using getwd() function). This parameter is relevant only if savePlots is set to TRUE.

width, height

Plot size in inches. If not supplied, uses the size of current graphics device.

dpi

Plot resolution. Also accepts a string input: "retina" (320), "print" (300), or "screen" (72). Applies only to raster output types.

Value

A single ggplot object if a single output path is specified.

A list of ggplot objects if multiple output paths are specified.

See also

Other sensitivity-calculation: sensitivityCalculation(), sensitivityTimeProfiles()

Examples

if (FALSE) {
simPath <- system.file("extdata", "Aciclovir.pkml", package = "ospsuite")
simulation <- loadSimulation(simPath)
outputPaths <- "Organism|PeripheralVenousBlood|Aciclovir|Plasma (Peripheral Venous Blood)"
parameterPaths <- c(
  "Aciclovir|Lipophilicity",
  "Applications|IV 250mg 10min|Application_1|ProtocolSchemaItem|Dose",
  "Neighborhoods|Kidney_pls_Kidney_ur|Aciclovir|Glomerular Filtration-GFR|GFR fraction"
)

# extract the results into a list of dataframes
results <- sensitivityCalculation(
  simulation = simulation,
  outputPaths = outputPaths,
  parameterPaths = parameterPaths
)

# print plots
sensitivitySpiderPlot(results)

# print and save plots
if (FALSE) {
  sensitivitySpiderPlot(
    results,
    savePlots = TRUE,
    height = 6,
    width = 12
  )
}
}