R/mcmc-run.R

In sakrejda/stannis: Handles output from Stan (mc-stan.org)

#' Read a single Stannis run, rewrite to binary format, and return 
#' dimensions and paths to outptu.
#' 
#' @param root where the run directories are rooted
#' @param hash hash for this run.
#' @param uuid UUID for this run.
#' @param control_file what the .yaml with run settings is called
#' @param sample_file what the sample output file is called
#' @param diagnostic_file file name for diagnostic output
#' @return list with run description
#' @export
read_run = function(root='.', hash = NULL, uuid = NULL, control_file = 'finalized.yaml', 
  sample_file = 'output.csv', diagnostic_file = 'diagnostics.csv'
) {
  if (!is.null(uuid) && is.null(hash)) {
    run_root = file.path(root, uuid)
    uuid = uuid
  } else if (!is.null(hash) && is.null(uuid)) {
    run_root = file.path(root, uuid(hash))
    uuid = uuid(hash)
  } else if (is.null(hash) && is.null(uuid)) {
    run_root = root
    uuid = uuid(run_root)
  } else {
    stop("Use either 'hash' or 'uuid' but not both.")
  }

  sample_file_path = file.path(run_root, sample_file)
  if (!file.exists(sample_file_path))
    stop("Sample file is missing.")

  diagnostic_file_path = file.path(run_root, diagnostic_file)
  if (!file.exists(diagnostic_file_path))
    stop("Diagnostic file is missing.")

  control_file_path = file.path(run_root, control_file)
  if (!file.exists(control_file_path))
    stop("Control file is missing.")

  sample_root = file.path(run_root, 'sample')
  if (!dir.exists(sample_root))
    dir.create(sample_root)

  diagnostic_root = file.path(run_root, 'diagnostic')
  if (!dir.exists(diagnostic_root))
    dir.create(diagnostic_root)

  comment = as.character(Sys.time())

  stannis::rewrite_stan_csv(source = sample_file_path, 
    root = sample_root,
    tag = uuid, comment = comment)
  stannis::rewrite_stan_csv(source = diagnostic_file_path, 
    root = diagnostic_root,
    tag = uuid, comment = comment)
  metadata = yaml::yaml.load_file(control_file_path)
  sample_dimensions = stannis::get_dimensions(sample_root)
  diagnostic_dimensions = stannis::get_dimensions(diagnostic_root)
 
  return(list(
    uuid = uuid,
    run_root = run_root,
    sample_root = sample_root,
    sample_dimensions = sample_dimensions,
    diagnostic_root = diagnostic_root,
    diagnostic_dimensions = diagnostic_dimensions,
    metadata = metadata
  ))
}