dot-plotDocumentation: Documentation for plotting functions

In IntiQuan/populationIsoboles: Calculate isoboles efficiently

Description

This function is only there to document parameters of plotting functions. This is necessary because inheritParams can only inherit from a single function and no plot uses all arguments of all plots

Usage

.plotDocumentation(
  finalPaths,
  grid,
  allPaths,
  itermax_dt,
  grid_fine,
  levels,
  Compound1 = getCompoundInfo("Compound1"),
  Compound2 = getCompoundInfo("Compound2"),
  filename = NULL,
  .inputFolder,
  FLAGoverwriteQuantiles = determineRecalcNeccessary(.inputFolder),
  ...
)

Arguments

finalPaths	Result from PI_getFinalPaths
grid	Result from PI_readGridValues
allPaths	Result from PI_readAllPaths
itermax_dt	Result from PI_readItermax
grid_fine	Result from aggregateIsoboles
levels	Vector of confidence levels, e.g. c(0.5,0.95). For plotRibbon, named vector with min and max, e.g. c(min = 0.025, max = 0.975)
Compound1, Compound2	Character. Compound name, for cases when it's not available in the Malaria project
filename	Path to save plot
.inputFolder	Folder where simulations are stored. Example: file.path(.outputFolder, "Simulations")
FLAGoverwriteQuantiles	Redo the calculation of the quantiles?
...	Arguments goint to ggsave

Examples

.inputFolder <- system.file("examples/Example-1/Outputs/Simulations",
  package = "populationIsoboles")
plotSpaghetti(.inputFolder)
plotQuantiles(.inputFolder)
plotCLRS(.inputFolder)

IntiQuan/populationIsoboles documentation built on Jan. 13, 2022, 8:29 p.m.