R/check_convergence_optim.R

In TheoPannetier/DDvTDtools: Compare diversity-dependent (DD) and time-dependent (TD) diversification models

#' Check optimisation results for completeness
#'
#' Reads result data frames in the optim folder and prints a message if there is
#' any missing row.
#'
#' @param folder the folder where the results files are stored. All .rds files
#' in the folder are read.
#'
#' @author Théo Pannetier
#'
#' @export

check_convergence_optim <- function(folder = "data/optim/"){
  assert_DDvTD_wd()

  files_list <- list.files(folder, pattern = ".rds")

  for(file in files_list){
    res <- readRDS(paste0(folder, file))

    missing_rows <- which(!(1:1000 %in% res$mc))
    if(length(missing_rows) > 0){
      cat(paste("File", file, ":", length(missing_rows), "missing rows\n"))
    }

    notConverged <- which(res$hasConverged == FALSE)
    if(length(notConverged > 0)){
      cat(paste("File", file, ": optimisation has not converged for", length(notConverged), "trees\n"))
    }
  }
}