R/get_transitive_closure.R

In BayesMallows: Bayesian Preference Learning with the Mallows Rank Model

#' Get transitive closure
#'
#' A simple method for showing any transitive closure computed by
#' [setup_rank_data()].
#'
#' @param rank_data An object of class `"BayesMallowsData"` returned from
#'   [setup_rank_data].
#'
#' @return A dataframe with transitive closure, if there is any.
#' @export
#'
#' @family preprocessing
#'
#' @examples
#' # Original beach preferences
#' head(beach_preferences)
#' dim(beach_preferences)
#' # We then create a rank data object
#' dat <- setup_rank_data(preferences = beach_preferences)
#' # The transitive closure contains additional filled-in preferences implied
#' # by the stated preferences.
#' head(get_transitive_closure(dat))
#' dim(get_transitive_closure(dat))
#'
get_transitive_closure <- function(rank_data) {
  if (inherits(rank_data$preferences, "BayesMallowsTransitiveClosure")) {
    rank_data$preferences
  } else {
    message("Intransitive comparisons, no closure exists.")
  }
}