R/reorder_vector.R

In mlr-org/mlr3misc: Helper Functions for 'mlr3'

#' @title Reorder Vector According to Second Vector
#'
#' @description
#' Returns an integer vector to order vector `x` according to vector `y`.
#'
#' @param x (`vector())`.
#' @param y (`vector()`).
#' @param na_last (`logical(1)`)\cr
#'   What to do with values in `x` which are not in `y`?
#'   * `NA`: Extra values are removed.
#'   * `FALSE`: Extra values are moved to the beginning of the new vector.
#'   * `TRUE`: Extra values are moved to the end of the new vector.
#' @return (`integer()`).
#' @export
#' @examples
#' # x subset of y
#' x = c("b", "a", "c", "d")
#' y = letters
#' x[reorder_vector(x, y)]
#'
#' # y subset of x
#' y = letters[1:3]
#' x[reorder_vector(x, y)]
#' x[reorder_vector(x, y, na_last = TRUE)]
#' x[reorder_vector(x, y, na_last = FALSE)]
reorder_vector = function(x, y, na_last = NA) {
  assert_flag(na_last, na.ok = TRUE)
  order(match(x, y), na.last = na_last, method = "radix")
}