Package index • ospsuite.plots

Plot Functions

Functions for creating plots

plotBoxWhisker(): Generate Box-Whisker Plots

plotForest(): Create a Forest Plot

plotHistogram(): Generates Histograms

plotPredVsObs(): Generate Predicted vs Observed Plots

plotQQ(): generates residual quantile quantile plot

plotRangeDistribution(): Plot Range Plot

plotRatioVsCov(): Generate Plots of Ratios vs Covariate

plotResVsCov(): Generate Residual Plots vs Covariate

plotTimeProfile(): generate time profile plots

plotYVsX(): Base Plot for Residuals and Predictions vs Covariates

Update/initialize plots

initialize plot or add to existing plots

initializePlot(): Initialize Plot

addXscale(): add X-scale

addYscale(): add y-scale

addLLOQLayer(): Add LLOQ Layer with LLOQ Lines

addXYScale(): Add X and Y Scale

Watermark

Functions to set watermark

addWatermark(): Add a watermark to a ggplot object

ggplotWithWatermark(): Create a ggplot with an optional watermark

plot(<ggWatermark>): Create plot function for ggWatermark.

print(<ggWatermark>): Print method for ggWatermark objects

Plot export

Functions to export plot

exportPlot(): Export a ggplot object to a file

Default settings

Functions to set and reset Settings for plot layout

Shapes: Shapes

colorMaps: Color maps

geomPointUnicode(): layer to point unicode as shapes

getDefaultGeomAttributes(): get the defaults for the geom attributes used as defaults in plot functions see vignette("ospsuite.plots", package = "ospsuite.plots") how to change defaults

getDefaultOptions(): get list of default options

getOspsuite.plots.option(): returns an option value for a option defined by the package OSPSuite.plots

resetDefaultColorMapDistinct(): reset the default color map for discrete colors

resetDefaultShapeDiscrete(): resets the scale for discrete shapes to ggplot default

resetDefaultTheme(): reset the default theme

resetDefaults(): restore to previously stored settings

setDefaultColorMapDistinct(): set the default color-map for discrete colors

setDefaultShapeDiscrete(): set the default shapes

setDefaultTheme(): set the default theme

setDefaults(): sets the defaults for the OSPSuite.plots package

setOspsuite.plots.option(): Set OSPSuite plots option with a given key and value.

DataMapping Classes

Classes combining data and Mapping

MappedData: MappedData

MappedDataBoxplot: MappedDataBoxplot

MappedDataRangeDistribution: object to map data for rangeplots

MappedDataTimeProfile: MappedDataTimeProfile

Constants

Enumeration constants for OSPSuite.plots options and scaling.

AxisScales: enumeration keys for OSPSuite.plots scaling options for axis scalings

OptionKeys: enumeration keys for OSPSuite.plots options

ResidualScales: enumeration keys for OSPSuite.plots scaling options for residual calculations

BINNINGMODE: enumeration keys for mode of Binning

Data

Data used within the vignette examples

exampleDataCovariates: Example Covariates Data

exampleDataTimeProfile: Example Time Profile Data

auxiliary functions

Classes combining data and Mapping

metaData2DataFrame(): converts metaData List to a data frame row names specify properties

CombinedPlot: CombinedPlot

constructLabelWithUnit(): Construct a Label with Unit

getFoldDistanceList(): creates a list with fold Distances

updateScaleArgumentsForTimeUnit(): adjust arguments for scale if dimension of scale is time