R/has_candidate_experiments.R

Defines functions has_candidate_experiments

Documented in has_candidate_experiments

#' Detect if there is at least one candidate model among the
#' set of experiments.
#' @inheritParams default_params_doc
#' @return one boolean
#' @export
has_candidate_experiments <- function(
  pir_params
) {
  pirouette::check_pir_params(pir_params)
  for (experiment in pir_params$experiments) {
    if (experiment$inference_conditions$model_type == "candidate") {
      return(TRUE)
    }
  }
  FALSE
}
richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.