Usage
exceptionalScores(dat, items = NULL, exception = 0.025, totalOnly = TRUE, append = TRUE, both = TRUE, silent = FALSE, suffix = "_isExceptional", totalVarName = "exceptionalScores")
Arguments
dat
The dataframe containing the variables to inspect, or the vector to inspect
(but for vectors, exceptionalScore
might be more useful).
items
The names of the variables to inspect.
exception
When an item will be considered exceptional, passed on as prob
to
exceptionalScore
.
totalOnly
Whether to return only the number of exceptional scores for each row in the
dataframe, or for each inspected item, which values are exceptional.
append
Whether to return the supplied dataframe with the new variable(s) appended
(if TRUE), or whether to only return the new variable(s) (if FALSE).
both
Whether to look for both low and high exceptional scores (TRUE) or not (FALSE;
see exceptionalScore
).
silent
Can be used to suppress messages.
suffix
If not returning the total number of exceptional values, for each inspected
variable, a new variable is returned indicating which values are exceptional.
The text string is appended to each original variable name to create the new
variable names.
totalVarName
If returning only the total number of exceptional values, and appending these
to the provided dataset, this text string is used as variable name.