distinct_values {mlr3misc} | R Documentation

## Get Distinct Values

### Description

Extracts the distinct values of an atomic vector, with the possibility to drop levels and remove missing values.

### Usage

    distinct_values(x, drop = TRUE, na_rm = TRUE)

### Arguments

`x` | (atomic `vector()`).
`drop` | :: `logical(1)` If `TRUE`, only returns values which are present in `x`. If `FALSE`, returns all levels for `factor()` and `ordered()`, as well as `TRUE` and `FALSE` for `logical()`s.
`na_rm` | :: `logical(1)` If `TRUE`, missing values are removed from the vector of distinct values.

### Value

(atomic `vector()`) with distinct values in no particular order.

### Examples

    # for factors:
    x = factor(c(letters[1:2], NA), levels = letters[1:3])
    distinct_values(x)
    distinct_values(x, na_rm = FALSE)
    distinct_values(x, drop = FALSE)
    distinct_values(x, drop = FALSE, na_rm = FALSE)

    # for logicals:
    distinct_values(TRUE, drop = FALSE)

    # for numerics:
    distinct_values(sample(1:3, 10, replace = TRUE))

[Package mlr3misc version 0.8.0 Index]