R/is_posterior.R

In ropensci/tracerer: Tracer from R

#' Determines if the input is a BEAST2 posterior
#' @param x the input
#' @return TRUE if the input contains all information of
#'   a BEAST2 posterior. Returns FALSE otherwise.
#' @author Richèl J.C. Bilderbeek
#' @examples
#' trees_filename <- get_tracerer_path("beast2_example_output.trees")
#' tracelog_filename <- get_tracerer_path("beast2_example_output.log")
#' posterior <- parse_beast_posterior(
#'   trees_filename = trees_filename,
#'   tracelog_filename = tracelog_filename
#' )
#' is_posterior(posterior)
#' @export
is_posterior <- function(x) {

  if (!inherits(x, "list")) {
    return(FALSE)
  }
  for (name in names(x)) {
    if (!grepl("trees$", name) && name != "estimates")
      return(FALSE)
  }
  return(TRUE)
}