R/get_max_stability.R

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

#' Get the maximum stability
#'
#' @param object An object of class "feasibilityAnalysis"
#' @return The maximum stability
#' @export
#'
#' @examples
#' fa.object <- feasibilityAnalysis(classes = 2, samples = 10, features = 15)
#' maximum.st <- get_max_stability(fa.object)
get_max_stability <- function(object) {
    UseMethod("get_max_stability")
}

#' @export
get_max_stability.feasibilityAnalysis <- function(object) {
    object$max_stability
}