R/get_performance_stats.R

Defines functions get_performance_stats

Documented in get_performance_stats

#' get_performance_stats
#'
#' Extract performance stats from an object of class `delboy`.
#'
#' @param delboy_res An object of class `delboy`.
#'
#' @return A data frame.
#' @export
get_performance_stats <- function(delboy_res){
  if(!inherits(delboy_res,"delboy")) stop(paste("expecting an object of class 'delboy', got:",class(delboy_res)))

  return(delboy_res$performance_stats_corr_FP)
}
alextkalinka/delboy documentation built on Feb. 2, 2022, 4:19 p.m.