R/get_optimal_parameter_used.R

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

#' Get the optimal parameter used
#'
#' @param object An object of class "optimalClustering"
#' @return The optimal parameter used
#' @export
#'
#' @examples
#' oc.object <- optimalClustering(toy_genes, 4, "spectral")
#' get_optimal_parameter_used(oc.object)
get_optimal_parameter_used <- function(object) {
    UseMethod("get_optimal_parameter_used")
}
#' @export
get_optimal_parameter_used.optimalClustering <- function(object) {
    object$optimal.parameter.used
}