getMaxIndex: Return index of maximal/minimal/best element in numerical...

In BBmisc: Miscellaneous Helper Functions for B. Bischl

Return index of maximal/minimal/best element in numerical vector.

Description

If x is empty or only contains NAs which are to be removed, -1 is returned.

Usage

getMaxIndex(x, weights = NULL, ties.method = "random", na.rm = FALSE)

getMinIndex(x, weights = NULL, ties.method = "random", na.rm = FALSE)

getBestIndex(x, weights = NULL, minimize = TRUE, ...)

Arguments

x	[numeric] Input vector.
weights	[numeric] Weights (same length as x). If these are specified, the index is selected from x * w. Default is NULL which means no weights.
ties.method	[character(1)] How should ties be handled? Possible are: “random”, “first”, “last”. Default is “random”.
na.rm	[logical(1)] If FALSE, NA is returned if an NA is encountered in x. If TRUE, NAs are disregarded. Default is FALSE
minimize	[logical(1)] Minimal element is considered best? Default is TRUE.
...	[any] Further arguments passed down to the delegate.

Value

[integer(1)].

Note

Function getBestIndex is a simple wrapper for getMinIndex or getMaxIndex respectively depending on the argument minimize.

BBmisc documentation built on Sept. 29, 2022, 5:12 p.m.