mapsRinteractive (version 1.0.0)

kth: kth

Description

Identification of the kth highest/lowest value(s).

Usage

kth(x = NULL, k = 2, highest = TRUE, index = FALSE,
  unique = FALSE, multiple = FALSE)

Arguments

x

Numeric vector.

k

Positive integer. The order of the value to find. Default = 2, which means that the next highest/lowest values is identified.

highest

Logical. TRUE means that the kth highest value(s) is/are identified. FALSE means that the kth lowest value(s) is/are identified. Default = TRUE.

index

Logical. TRUE means that the index/indices of the kth highest/lowest value(s) is/are returned. FALSE means that the kth highest/lowest value itself is returned. If ties exist and argument multiple = TRUE, the returned value is a vector, else it is a value. Default=FALSE.

unique

Logical. TRUE means that duplicates are removed before the identification of the kth highest/lowest value(s). Default=FALSE

multiple

Logical. TRUE means that, If ties exist a vector of all values in x that are equal to the kth highest/lowest values is returned. FALSE means that one random value from the vector of index values is returned. Default=FALSE

Value

If index = FALSE: the kth highest/lowest value is returned.

If index = TRUE: the index of the kth highest/lowest value (s) is/are returned.

Details

NA values are removed.

Examples

# NOT RUN {
kth(x=1:20, k=3, highest=FALSE)

# }