View source: R/PKNCA.options.R
PKNCA.options | R Documentation |
This function will set the default PKNCA options. If given no
inputs, it will provide the current option set. If given name/value
pairs, it will set the option (as in the options
function). If given a name, it will return the value for the
parameter. If given the default
option as true, it will
provide the default options.
PKNCA.options(..., default = FALSE, check = FALSE, name, value)
... |
options to set or get the value for |
default |
(re)sets all default options |
check |
check a single option given, but do not set it (for validation of the values when used in another function) |
name |
An option name to use with the |
value |
An option value (paired with the |
Options are either for calculation or summary functions. Calculation
options are required for a calculation function to report a result
(otherwise the reported value will be NA
). Summary options are
used during summarization and are used for assessing what values are
included in the summary.
See the vignette 'Options for Controlling PKNCA' for a current list
of options (vignette("Options-for-Controlling-PKNCA", package="PKNCA")
).
If...
returns the current options.
returns NULL
the current value of that option is returned as a scalar
the current values of those options are returned as a list
PKNCA.options.describe
Other PKNCA calculation and summary settings:
PKNCA.choose.option()
,
PKNCA.set.summary()
PKNCA.options()
PKNCA.options(default=TRUE)
PKNCA.options("auc.method")
PKNCA.options(name="auc.method")
PKNCA.options(auc.method="lin up/log down", min.hl.points=3)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.