R/read_comsie_tbl.R

In TheoPannetier/comsie: R implementation of a Competitive Radiation model

#' Read simulation data
#'
#' Reads a `.csv` file as produced by [run_simulation()] and returns the parsed
#' table it contains.
#'
#' @param path_to_file character, path to the `.csv` file.
#' @param skip numeric, number of lines (of metadata) to skip. Passed to
#' [readr::read_csv()]. If left NULL, the function will use a regexp to find
#' where the simulation output starts.
#'
#' @author Théo Pannetier
#' @export

read_comsie_tbl <- function(path_to_file, skip = NULL) {

  comrad::testarg_char(path_to_file)
  if (!path_to_file %>% stringr::str_detect("\\.csv$")) {
    stop("'path_to_file' must be a .csv")
  }

  # Find where simulation output starts
  if (is.null(skip)) {
    comsie_str <- readLines(path_to_file)
    skip <- stringr::str_which(
      comsie_str,
      pattern = "### Simulation output ###"
    )
  }
  comsie_tbl <- readr::read_csv(
    path_to_file,
    skip = skip, # skip metadata
    col_types = readr::cols(
      readr::col_number(),    # t
      readr::col_number(),    # z
      readr::col_character(), # species
      readr::col_character(), # ancestral_species
      readr::col_character() # founder
    )
  )
  return(comsie_tbl)
}