R/summary.spFSR.R

In spFSR: Feature Selection and Ranking via Simultaneous Perturbation Stochastic Approximation

#' Summarising a spFSR object
#'
#' @param object A \code{spFSR} object
#' @param ... Additional arguments
#'
#' @return Summary of a spFSR object consisting of number of features selected, wrapper type, total number of iterations, the best performing features, and the descriptive statistics of the best iteration result (the iteration where the best performing features are found).
#'
#' @seealso \link[spFSR]{getImportance}, \link[spFSR]{spFSR.default}, and \link[spFSR]{spFeatureSelection}.
#'
#'
#' @export
summary.spFSR <- function(object, ...){

  if( !inherits(object, 'spFSR')  ){
    warning('Not a spFSR object.')
    importance <- data.frame()
  }else{
    importance <- data.frame(features = object$features,
                         importance = object$importance)
  }

  results <- list( target = object$task.spfs$target_names,
                   importance = importance,
                   nfeatures = object$num.features,
                   niters = object$total.iters,
                   name = object$wrapper$label,
                   best.iter = object$best.iter,
                   best.value = object$best.value,
                   best.std = object$best.std)

  class(results) <- 'summary.spFSR'
  results
}