R/get_partition_agreement_scores.R

In BioSok/omada: Machine learning tools for automated transcriptome clustering analysis

#' Get a dataframe of partition agreement scores for a set of random parameters
#' clustering runs across different methods
#'
#' @param object An object of class "methodSelection"
#' @return A dataframe of partition agreement scores for a set of random
#' parameters clustering runs across different methods
#' @export
#'
#' @examples
#' ms.object <- clusteringMethodSelection(toy_genes, method.upper.k = 3,
#' number.of.comparisons = 2)
#' get_partition_agreement_scores(ms.object)
get_partition_agreement_scores <- function(object) {
    UseMethod("get_partition_agreement_scores")
}
#' @export
get_partition_agreement_scores.methodSelection <- function(object) {
    object$partition.agreement.scores
}