get.GOF.dictionary: Get, set, and modify the global (or local) GOF parameters and...

View source: R/GOF.control.R

get.GOF.dictionaryR Documentation

Get, set, and modify the global (or local) GOF parameters and GOF dictionary for labels

Description

The current global GOF parameters and dictionary is automatically applied to every plot you draw. Use 'get.GOF.params' to get the current GOF parameters, and 'set.GOF.params' to change one or several parameters. To change settings for one GOF only you can use GOF.control as input to the GOF function. See details below for complete list of GOF parameters.

Similarly use 'get.GOF.dictionary' and 'set.GOF.dictionary' for the dictionary of labels. 'set.GOF.dictionary' also allows for adding new items to the dictionary.

Use ‘set.ETA.labels' to set labels for ETA’s in all plots

Usage

get.GOF.dictionary()

set.GOF.dictionary(...)

default.GOF.dictionary()

set.GOF.params(...)

get.GOF.params()

default.GOF.params()

set.ETA.labels(labels)

set.script.name(script.name)

GOF.control(...)

Arguments

...

named list of GOF parameter or GOF dictionary for labels

labels

vector of character strings with the labels

script.name

character strings for script name to put at end of caption

Details

Table below describe each of the global GOF parameters that can be modified by 'set.GOF.params'

Parameter Default Description
col.data "gray20" color for points in all GOFs
cex.data 1.5 cex for points in all GOFs
pch.data 19 pch for points in all GOFs
alpha.data 0.5 alpha for points in all GOFs
col.smooth "#3366FF" color for smoothers
lty.smooth 1 lty for smoothers
lwd.smooth 1 lwd for smoothers
se.smooth TRUE show confidence interval for loess smoother (TRUE) or not (FALSE)
span.smooth 0.6666667 span parameter for loess smothers
degree.smooth 1 degree parameter for loess smothers
family.smooth "symmetric" family parameter for loess smothers
col.refline "red" color for reference lines in all GOFs
lty.refline 2 lty for reference lines in all GOFs
lwd.refline 1 lwd for reference lines in all GOFs
fill.hist "gray30" color for filling of histograms
col.hist "transparent" color for border of histograms
alpha.hist 0.5 alpha for fill area in histograms
fill.box "steelblue" color for filling of box-plots
col.box "black" color for border and whisker of box-plots
alpha.box 0.6 alpha for fill area in box-plots
axis.labels TRUE use dictionary for labels (TRUE) or just use column names for axis labels (FALSE)
add.caption TRUE add caption to GOF plots (true) or not (FALSE)
size.caption 8 size for caption text
col.caption 1 color for caption text
caption.path.depth 99 number of folders levels to include in caption
corr.fontface 4 font face for correlation in eta.pairs.GOF
eta.labels NULL vector of labels for ETA's
script.name "" script name for caption

Examples

### Example setting ETA labels
set.ETA.labels(c("Ka","CL","V"))
### Example setting script name
set.script.name("MyScript.R")

nonmem2R documentation built on April 15, 2022, 1:05 a.m.