R/check_pff_twinning_params.R

Defines functions check_pff_twinning_params

Documented in check_pff_twinning_params

#' Check if the twinning parameters have PFF
#' @inheritParams default_params_doc
#' @export
check_pff_twinning_params <- function(twinning_params) {
  # NA denotes a 'do not use twinning' and is a valid value
  if (beautier::is_one_na(twinning_params)) return()

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