R/collect_n_species_trees.R

In richelbilderbeek/wiritttea: WIRITTTE analysis

#' Collect the number of sampled species trees in a parameter file
#' @param filename name of the file containing the parameters and results
#' @return a data frame
#' @examples
#'  filename <- find_path("toy_example_1.RDa")
#'  df <- collect_n_species_trees(filename)
#'  testit::assert(names(df) == c("n_species_trees"))
#'  testit::assert(ncol(df) == 1)
#'  testit::assert(nrow(df) == 1)
#'  testit::assert(df$n_species_trees[1] >= 1)
#' @export
#' @author Richel Bilderbeek
collect_n_species_trees <- function(filename) {

  if (!wiritttes::is_valid_file(filename = filename)) {
    stop("invalid file")
  }

  file <- wiritttes::read_file(filename)
  n <- sum(!is.na(file$species_trees))
  return(data.frame(n_species_trees = n))
}