R/are_site_models.R

In richelbilderbeek/beastscriptr: 'BEAUti' from R

#' Determine if x consists out of site_models objects
#' @param x the object to check if it consists out of site_models objects
#' @return TRUE if x, or all elements of x, are site_model objects
#' @seealso Use \link{create_site_model} to create a site model
#' @examples
#' check_empty_beautier_folder()
#'
#' jc69_site_model <- create_jc69_site_model()
#' gtr_site_model <- create_gtr_site_model()
#' both_site_models <- list(jc69_site_model, gtr_site_model)
#'
#' # TRUE
#' are_site_models(jc69_site_model)
#'
#' # TRUE
#' are_site_models(gtr_site_model)
#'
#' # TRUE
#' are_site_models(both_site_models)
#'
#' check_empty_beautier_folder()
#' @author Richèl J.C. Bilderbeek
#' @export
are_site_models <- function(
  x
) {
  if (is.null(x)) return(FALSE)
  if (is_site_model(x)) return(TRUE)
  for (i in x) {
    if (!is_site_model(i)) return(FALSE)
  }
  return(TRUE)
}