R/get_average_stabilities_per_k.R

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

#' Get average stabilities for all numbers of clusters(k)
#'
#' @param object An object of class "feasibilityAnalysis"
#' @return Average stabilities for all numbers of clusters(k)
#' @export
#'
#' @examples
#' fa.object <- feasibilityAnalysis(classes = 2, samples = 10, features = 15)
#' average.sts.k <- get_average_stabilities_per_k(fa.object)
get_average_stabilities_per_k <- function(object) {
    UseMethod("get_average_stabilities_per_k")
}

#' @export
get_average_stabilities_per_k.feasibilityAnalysis <- function(object) {
    object$avg_stabilities_per_k
}