R/get_runtime_params.R

In Neves-P/DAISIErobustness: Test the Robustness of DAISIE to Geodynamics and Traits

#' Make runtime data frame
#'
#' @inheritParams default_params_doc
#'
#' @return
#' A data frame with three columns:
#' \describe{
#'   \item{\code{param_space_name}}{Atomic character vector with parameter space
#'     name.}
#'   \item{\code{param_set}}{Atomic numeric vector with parameter space number.}
#'   \item{\code{runtime}}{Atomic numeric vector with Peregrine job run time in
#'   seconds.}
#'   \item{\code{status}}{character with job status upon conclusion.}
#'   \item{\code{log_name}}{Character vector with name of corresponding log file
#'   to facilitate debugging.}
#' }
#' @author Pedro Santos Neves
#' @export
#' @keywords internal
#'
#' @examples
#' \dontrun{
#' runtimes_data_frame <- get_runtime_params("logs/")
#' }
get_runtime_params <- function(logs_folder_path) {
  log_paths <- list.files(
    logs_folder_path,
    full.names = TRUE,
    pattern = ".log"
  )

  out <- data.frame(
    "param_space_name" = character(),
    "param_set" = numeric(),
    "runtime" = numeric(),
    "status" = character(),
    "log_name" = character()
  )

  pb <- utils::txtProgressBar(
    min = 1,
    max = length(log_paths),
    style = 3
  )
  for (i in seq_along(log_paths)) {

    log_name <- basename(log_paths[i])
    log_lines <- read_log_file(log_paths[i])

    param_space_name <- read_param_space_name_log(
      log_lines = log_lines,
      log_file_path = log_paths[i]
    )
    param_set <- read_param_set_log(
      log_lines = log_lines,
      log_file_path = log_paths[i]
    )
    runtime <- read_runtime_log(
      log_lines = log_lines,
      log_file_path = log_paths[i]
    )
    status <- read_status_log(log_lines = log_lines)

    out[i, "param_space_name"] <- param_space_name
    out[i, "param_set"] <- param_set
    out[i, "runtime"] <- runtime
    out[i, "status"] <- status
    out[i, "log_name"] <- log_name
    utils::setTxtProgressBar(pb, i)
  }

  out <- out[order(out$param_space_name, out$param_set), ]
  testit::assert(nrow(out) == length(log_paths))
  testit::assert(is.data.frame(out))
  out
}