histogram.bootstrap: Bootstrap Histograms

In qPharmetra/qpToolkit: qPharmetra R Tools

Bootstrap Histograms

Description

Create histograms of PsN boostrap output read with read.bootstrap

Usage

## S3 method for class 'bootstrap'
histogram(
  bootstrap,
  filename.prefix = "bootstrapPage",
  path,
  incl.ids = NULL,
  min.failed = FALSE,
  cov.failed = FALSE,
  cov.warnings = FALSE,
  boundary = FALSE,
  showoriginal = TRUE,
  showmean = TRUE,
  obsCentralCol = "blue",
  bootCentralCol = "red",
  outerCol = "darkslategray",
  showmedian = FALSE,
  show95CI = TRUE,
  conf.int = 0.95,
  showquart = FALSE,
  histCol = "#F2F2F2",
  densityCol = "red",
  excl.id = c(),
  excl.columns = c("model", "minimization.successful", "covariance.step.successful",
    "covariance.step.warnings", "estimate.near.boundary"),
  digits = 3,
  ...
)

Arguments

bootstrap	Output generated by read.bootstrap
filename.prefix	Prefix for filenames of PDFs created,
path	Directory where graph files should appear (default reads from output)
incl.ids	Include individuals in the plot? Defaults to NULL
min.failed	Logical (defaults to FALSE) do we want to omit minimization failed runs?
cov.failed	Logical (defaults to FALSE) do we want to omit covariance failed runs?
cov.warnings	Logical (defaults to FALSE) do we want to omit covariance failed runs?
boundary	Logical (defaults to FALSE) do we want to omit boundary runs?
showoriginal	Logical (defaults to TRUE) to show line for original estimate
showmean	Logical (defaults to TRUE) to show line for mean
obsCentralCol	Color of observed central tendency
bootCentralCol	Color of bootstrapped central tendency
outerCol	Color of outer region polygon
showmedian	Logical (defaults to FALSE) to show line for median
show95CI	Logical (defaults to TRUE) show line for 95% confidence interval (percentile)
conf.int	Confidence level for bootstrap sample outer bands
showquart	Logical (defaults to FALSE) to show line for quartiles
histCol	Histogram bar color
densityCol	Color of polygon
excl.id	Exclude samples that have this individual
excl.columns	What elements should not be shown?
digits	number of significant digits
...	Optional arguments passed on to hist

Value

Histograms of bootstrapped parameter estimates

Examples

myBoot = read.bootstrap(path = getOption("qpExampleDir"),
filename = "bootstrap/raw_results_bs4011.csv",
structure.filename = "bootstrap/raw_results_structure")
temp.dir = tempdir()
cat(temp.dir)
histogram.bootstrap(myBoot, path = temp.dir, filename.prefix = "Test")
## now take a look there

qPharmetra/qpToolkit documentation built on May 24, 2023, 8:52 a.m.