R/check_pff_pir_params.R

Defines functions check_pff_pir_params

Documented in check_pff_pir_params

#' Check if the \code{pir_params} are valid and Peregrine-friendly.
#'
#' Will \link{stop} if the \code{pir_params} are invalid
#' or Peregrine-unfriendly, else will do nothing
#' @inheritParams default_params_doc
#' @author Richèl J.C. Bilderbeek
#' @export
check_pff_pir_params <- function(
  pir_params
) {
  pirouette::check_pir_params(pir_params)

  if (!beautier::is_one_na(pir_params$evidence_filename) &&
    !peregrine::is_pff(pir_params$evidence_filename)) { # nolint this indentation is what I want
    stop("Peregrine-unfriendly filename for 'pir_params$evidence_filename'")
  }
  peregrine::check_pff_twinning_params(pir_params$twinning_params)
  peregrine::check_pff_alignment_params(pir_params$alignment_params)
  peregrine::check_pff_experiments(pir_params$experiments)
}
richelbilderbeek/peregrine documentation built on Jan. 3, 2024, 7:42 p.m.