create_test_pir_params_setup: Create a 'pir_params' that follows a specific setup

View source: R/create_test_pir_params_setup.R

create_test_pir_params_setupR Documentation

Create a pir_params that follows a specific setup

Description

Create a pir_params that follows a specific setup

Usage

create_test_pir_params_setup(has_candidate = FALSE, has_twinning = FALSE)

Arguments

has_candidate

TRUE to have a candidate experiment

has_twinning

TRUE to use twinning

Value

a 'pir_params' (see create_pir_params)

Examples

if (beautier::is_on_ci()) {

  # Minimal use
  check_pir_params(create_test_pir_params_setup())

  # Generative experiment only, without twinning
  create_test_pir_params_setup(
    has_candidate = FALSE,
    has_twinning = FALSE
  )

  # Generative and candidate experiment, without twinning
  if (rappdirs::app_dir()$os != "win") {
    create_test_pir_params_setup(
      has_candidate = TRUE,
      has_twinning = FALSE
    )
  }

  # Generative experiment only, with twinning
  create_test_pir_params_setup(
    has_candidate = FALSE,
    has_twinning = TRUE
  )

  # Generative and candidate experiment, with twinning
  if (rappdirs::app_dir()$os != "win") {
    create_test_pir_params_setup(
      has_candidate = TRUE,
      has_twinning = TRUE
    )
  }
}

richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.