R/choose_best_model.R

In tece-lab/DAISIEutils: Utility Functions for the DAISIE Package

#' From multiple seeds, choose the best model fit
#'
#' @inheritParams default_params_doc
#'
#' @return A list of length one, with a data frame of 1 row containing the best
#'   estimated models from the given seeds, as determined by the loglik.
#'   If no model was estimated successfully, returns similar structure with all
#'   fields as `NA`.
#' @export
#'
#' @author Pedro Santos Neves
choose_best_model <- function(model_lik_res) {
  logliks <- unlist(lapply(X = model_lik_res, FUN = "[[", "loglik"))
  if (all(is.na(logliks))) {
    best_model <- model_lik_res[1]
  } else {
    best_loglik_index <- which(logliks == max(logliks, na.rm = TRUE))
    best_model <- model_lik_res[best_loglik_index]
  }
  testit::assert(length(best_model) == 1)

  return(best_model[[1]])
}