R/sort_itemnames.R

In D-score/dscore: D-Score for Child Development

#' Sorts item names according to user-specified priority
#'
#' This function sorts the item names according to instrument,
#' domain, mode and number. The user can specify the sorting
#' order.
#' @param x A character vector containing item names (gsed lexicon)
#' @param order A four-letter string specifying the sorting order.
#' The four letters are: `i` for instrument, `d` for domain,
#' `m` for mode and `n` for number. The default is
#' `"idnm"`.
#' @return `sort_itemnames()` return a character vector with
#' `length(x)` sorted elements. `order_itemnames()` return
#' an integer vector of length `length(x)` with positions of
#' the sorted elements.
#' @seealso [decompose_itemnames()]
#' @author Stef van Buuren
#' @examples
#' itemnames <- c("aqigmc028", "grihsd219", "", "by1mdd157", "mdsgmd006")
#' sort_itemnames(itemnames)
#' @export
sort_itemnames <- function(x, order = "idnm") {
  x[order_itemnames(x, order)]
}

#' @rdname sort_itemnames
#' @export
order_itemnames <- function(x, order = "idnm") {
  din <- decompose_itemnames(x)
  order(
    din[, pmatch(substr(order, 1, 1), names(din))],
    din[, pmatch(substr(order, 2, 2), names(din))],
    din[, pmatch(substr(order, 3, 3), names(din))],
    din[, pmatch(substr(order, 4, 4), names(din))]
  )
}